Skip to content

Revise citation details#19

Merged
egrace479 merged 5 commits intomainfrom
citation-fix
Apr 25, 2026
Merged

Revise citation details#19
egrace479 merged 5 commits intomainfrom
citation-fix

Conversation

@egrace479
Copy link
Copy Markdown
Member

Completed the conference paper preferred citation.

Once this is merged, I can snapshot the zip to Zenodo, but should we also update links to the published paper instead of arXiv?

complete conference paper preferred citation
@egrace479 egrace479 requested a review from hlapp April 22, 2026 23:40
@egrace479 egrace479 added the documentation Improvements or additions to documentation label Apr 22, 2026
Copy link
Copy Markdown
Member

@hlapp hlapp left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

We should probably double-check after merging whether it renders to the expected BibTeX in the sidebar. I don't think we can check that beforehand, right?

@egrace479
Copy link
Copy Markdown
Member Author

egrace479 commented Apr 24, 2026

@hlapp, you mean check it on the branch?

It doesn't seem to include the proceedings or the page numbers, despite following the conference paper format. The alternative would be to leave just the software citation and ask for users to cite both in the README (with the proper bibtex there), since @harishB97 did set it up with both:

If you find this software helpful in your research, please cite both the software and our paper.

Screenshot 2026-04-24 at 10 23 30 AM

Copy link
Copy Markdown
Member

@hlapp hlapp left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

It seems other fields need to be used for conference papers. The 2nd example for references shows this. See collection-title and collection-type.

See inline suggestion. Not sure it will work as desired (would need committing first I suppose).

That's great that you can actually check on a branch.

Comment thread CITATION.cff Outdated
@egrace479
Copy link
Copy Markdown
Member Author

I found a bibtex to cff crosswalk that indicated pages should be noted through start and end keys. After making that change, they show up.

Copy link
Copy Markdown
Member

@hlapp hlapp left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Yay!

@hlapp
Copy link
Copy Markdown
Member

hlapp commented Apr 24, 2026

Perhaps we should carry some of this back to the Guide where it talks about the CITATION.cff file?

@egrace479
Copy link
Copy Markdown
Member Author

Perhaps we should carry some of this back to the Guide where it talks about the CITATION.cff file?

Yes, I did open an issue to do so.

@egrace479 egrace479 merged commit 0669892 into main Apr 25, 2026
@egrace479 egrace479 deleted the citation-fix branch April 25, 2026 00:08
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

documentation Improvements or additions to documentation

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants