lincc-frameworks / lincc-frameworks/citation-compass
Clean up "References" reST directives
Nobody has claimed this yet.
- Dominant language
- Python
- Stars
- 3
- Forks
- 0
- Avg merge
- 2h 32m
- Merged PRs (30d)
- 1
Description
TIL that the "References" section should have footnote-style directives.
e.g.
```
"""Create a Passband object from the SVO [1]_, [2]_, [3]_ Filter Profile Service.
References
----------
.. [1] Rodrigo, C., Cruz, P., Aguilar, J.F., et al. 2024;
https://ui.adsabs.harvard.edu/abs/2024A%26A...689A..93R/abstract
.. [2] Rodrigo, C., Solano, E., Bayo, A., 2012;
https://ui.adsabs.harvard.edu/abs/2012ivoa.rept.1015R/abstract
.. [3] Rodrigo, C., Solano, E., 2020; https://ui.adsabs.harvard.edu/abs/2020sea..confE.182R/abstract
```
This results in a really nice rendering via read the docs:
The `.. [1] ` kind of text at the beginning of those lines can be removed for ease of copy/paste.
See:
https://numpydoc.readthedocs.io/en/latest/format.html#references
Contributor guide
No contributing guide indexed for this repository
First steps
- Read the whole issue, then the project's contributing guide.
- Comment on the issue to say you are picking it up — it saves two people doing the same work.
- Fork the repository and make your change on a branch.
- Open a pull request that references the issue number.
Research direction
Search the repository for docstrings with a References section and the `.. [1]`-style directives shown in the issue. Compare their formatting with the linked numpydoc guidance and confirm the rendered documentation preserves the intended footnote presentation while making the reference text easier to copy and paste.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- python
- Domain
- documentation
- Issue type
- Documentation
- Difficulty
- 2/5
- Estimated time
- 1-3 hours
- Activity status
- Quiet
- Clarity
- Mostly clear
- Newbie friendliness
- 68/100