Skip to content

Consistent style for references to external material #3273

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

Open
wafels opened this issue Jul 17, 2019 · 6 comments
Open

Consistent style for references to external material #3273

wafels opened this issue Jul 17, 2019 · 6 comments
Labels
Effort Low Requires a small time investment. Package Novice Requires little technical knowledge of the package. Priority Low Rapid action not required.

Comments

@wafels
Copy link
Member

wafels commented Jul 17, 2019

Description

We should have a consistent style in order to refer to external material. For example, references to papers, either in the example gallery or in code docstrings, should be consistent. The example below is one way of formatting a reference.

Howard, R.F., Harvey, J.W. & Forgach, S. Sol Phys (1990) 130: 295. https://doi.org/10.1007/BF00156795

The DOI should be given in preference to any other kind of link to a digital object.

Discuss!

@nabobalis nabobalis added Documentation Effort Low Requires a small time investment. Package Novice Requires little technical knowledge of the package. Priority Low Rapid action not required. labels Jul 17, 2019
@Cubostar

This comment has been minimized.

@wafels
Copy link
Member Author

wafels commented Aug 6, 2019

The idea is that wherever we refer to a document source that has a DOI, the DOI should be used. The text that goes along with the example above is just one way of referring to the document in text. I don't have a strong preference as to how that is formatted. If someone can suggest a standard, then I am fine with that. For example, we could adopt the Astrophysical Journal reference style: https://journals.aas.org/references/

@mbobra
Copy link
Member

mbobra commented Dec 2, 2019

I agree with adopting the AAS style guide. Maintaining an in-house style guide takes a lot of time.

@wtbarnes
Copy link
Member

wtbarnes commented Dec 2, 2019

I'm also 👍 on using the AAS guide.

@Cadair
Copy link
Member

Cadair commented Dec 2, 2019

We can also look at / adopt the astropy style guide: https://docs.astropy.org/en/latest/development/style-guide.html

@mbobra
Copy link
Member

mbobra commented Dec 3, 2019

The AstroPy style guide is not complete (it is only for narratives) and does not have a style guideline for citations, which was @wafels' initial concern. The AstroPy style guide also relies on AP style (proprietary), whereas AAS style is publicly available.

@kakirastern kakirastern added the Hacktoberfest Issues that could be the focus of GSoC or Hacktoberfests label Sep 28, 2020
SuleimanFarah added a commit to SuleimanFarah/sunpy that referenced this issue Apr 4, 2023
@dstansby dstansby removed the Hacktoberfest Issues that could be the focus of GSoC or Hacktoberfests label Apr 16, 2023
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Effort Low Requires a small time investment. Package Novice Requires little technical knowledge of the package. Priority Low Rapid action not required.
Projects
None yet
Development

No branches or pull requests

8 participants