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

BUG, DOC: Correct adsurl value and add a general url field in CITATION.bib #18795

Merged
merged 2 commits into from Jun 30, 2023

Conversation

cgobat
Copy link
Contributor

@cgobat cgobat commented Jun 29, 2023

Reference issue

N/A

What does this implement/fix?

The repository's CITATION.bib file currently defines a value for the adsurl key that is not, in fact, an ADS URL. The rdcu.be link that's currently there is not what LaTeX/BibTeX styles and formatters that look for and/or use entries' adsurl keyword expect to find, and it's not the intended/generally accepted use of the keyword either. This PR corrects that, and provides a link to the publication's ADS page.

Additional information

NASA's ADS (Astrophysics Data System) is a widely-used resource in the physics and astronomy scientific community. It is the "industry-standard" tool for searching/browsing scholarly works in the field. Many LaTeX bibstyles, including AASTeX, MNRAS, and A&A, give special treatment to the value associated with the adsurl keyword in BibTeX entries.

@cgobat cgobat changed the title BUG: Correct adsurl value in CITATION.bib BUG, DOC: Correct adsurl value in CITATION.bib Jun 29, 2023
@@ -18,6 +18,6 @@ @ARTICLE{2020SciPy-NMeth
year = {2020},
volume = {17},
pages = {261--272},
adsurl = {https://rdcu.be/b08Wh},
adsurl = {https://ui.adsabs.harvard.edu/abs/2020NatMe..17..261V},
Copy link
Contributor

Choose a reason for hiding this comment

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

@tupui what do you think about the alternative - just making this a regular URL? I'm a fan of astrophysics, but I don't think this should be domain specific.

Copy link
Contributor Author

@cgobat cgobat Jun 30, 2023

Choose a reason for hiding this comment

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

There is the url keyword if a generic URL is desired. The adsurl keyword is, by identity, for an ADS link.

Copy link
Contributor Author

Choose a reason for hiding this comment

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

I went ahead and added this field (url) as well since it was previously not present.

Copy link
Member

Choose a reason for hiding this comment

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

Mmm I would remove this field entirely. The DOI is the real reference URL and we should not have to rely on any external/domain specific service.

@cgobat cgobat changed the title BUG, DOC: Correct adsurl value in CITATION.bib BUG, DOC: Correct adsurl value and add a general url field in CITATION.bib Jun 30, 2023
@cgobat
Copy link
Contributor Author

cgobat commented Jun 30, 2023

@tupui @mdhaber I hear you guys about domain specificity, but in my opinion, more metadata is almost always a good thing (as long as it doesn't cause problems, which in this case it doesn't). Keep in mind that $\LaTeX$ citation styles that don't use the adsurl field will simply ignore it, and just because something is present in this .bib file doesn't mean it will appear in the typeset reference. In fact, you could even add a line that said madeupfield = {meaninglesscontent}, and it wouldn't have any effect on the output. Non-ADS-aware citation styles that use doi and/or url can still find and use those fields just fine.

@mdhaber
Copy link
Contributor

mdhaber commented Jun 30, 2023

Sound like a fair point. @tupui you ok with that?

@tupui
Copy link
Member

tupui commented Jun 30, 2023

Alright alright 😅 well and why not since the field was in fact already there.

@tupui
Copy link
Member

tupui commented Jun 30, 2023

Go ahead for the merge if you agree Matt :) (I would do it but not 100% sure you are onboard)

@mdhaber mdhaber merged commit 5353f12 into scipy:main Jun 30, 2023
1 check passed
@cgobat
Copy link
Contributor Author

cgobat commented Jun 30, 2023

Thanks guys—cheers! 😀

@j-bowhay j-bowhay added this to the 1.12.0 milestone Jun 30, 2023
@tupui
Copy link
Member

tupui commented Jun 30, 2023

Thanks to you for raising it 😃

@cgobat cgobat deleted the fix-adsurl branch July 14, 2023 16:45
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

4 participants