Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Update citation file #7479

Merged
merged 1 commit into from
Aug 28, 2024
Merged

Update citation file #7479

merged 1 commit into from
Aug 28, 2024

Conversation

Armavica
Copy link
Member

@Armavica Armavica commented Aug 26, 2024

Switch to CITATION.cff.

Validated with cffconvert.

Description

Related Issue

Checklist

Type of change

  • New feature / enhancement
  • Bug fix
  • Documentation
  • Maintenance
  • Other (please specify):

📚 Documentation preview 📚: https://pymc--7479.org.readthedocs.build/en/7479/

@Armavica Armavica added the no releasenotes Skipped in automatic release notes generation label Aug 26, 2024
@aloctavodia
Copy link
Member

aloctavodia commented Aug 26, 2024

Probably better to switch to cff, see #7477

@Armavica
Copy link
Member Author

In my understanding it's for a different purpose: while the bib is for the paper, the cff is for a specific version of the software, but I could be wrong and would be happy to be corrected.

@aloctavodia
Copy link
Member

cff is for the paper. See https://github.com/arviz-devs/preliz/blob/main/CITATION.cff as an example.

CITATION.bib Outdated
pages={e1516},
year={2023},
doi={10.7717/peerj-cs.1516}
title = {{PyMC}: a modern, and comprehensive probabilistic programming framework in {Python}},
Copy link
Member

Choose a reason for hiding this comment

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

What about the upper case?

Copy link
Member Author

Choose a reason for hiding this comment

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

First of all, the published title is not in title case: https://peerj.com/articles/cs-1516/

Besides, upper or lower case are irrelevant in bibtex entries, unless wrapped in extra {}s. BibTeX will apply title case or normal case to all titles depending on the style sheet.

This version preserves the original case better, by wrapping PyMC and Python in extra {}s (see ref. 111 of https://arxiv.org/pdf/2408.09024 likely generated from the previous bib file).

@Armavica
Copy link
Member Author

@aloctavodia I generated a cff file semi-manually and validated it with cffconvert.

@aloctavodia
Copy link
Member

LGTM!

@aloctavodia aloctavodia merged commit d313012 into pymc-devs:main Aug 28, 2024
10 checks passed
@Armavica Armavica deleted the citation branch October 7, 2024 14:57
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
no releasenotes Skipped in automatic release notes generation
Projects
None yet
Development

Successfully merging this pull request may close these issues.

DOC: Add a CITATION.cff file
3 participants