-
-
Notifications
You must be signed in to change notification settings - Fork 605
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
Comments
This comment has been minimized.
This comment has been minimized.
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/ |
I agree with adopting the AAS style guide. Maintaining an in-house style guide takes a lot of time. |
I'm also 👍 on using the AAS guide. |
We can also look at / adopt the astropy style guide: https://docs.astropy.org/en/latest/development/style-guide.html |
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.
The DOI should be given in preference to any other kind of link to a digital object.
Discuss!
The text was updated successfully, but these errors were encountered: