documentation
documentation copied to clipboard
Link to correct documentation page which describes the docstrings style
In the section In-code documentation — How to document your research software documentation it reads
Read more: https://peps.python.org/pep-0257/
although the PEP does not specify any particular format or convention for parsing Python docstrings. The same problem exists for other languages. It could be a good idea to add one more link for further reading:
- Python:
- https://www.sphinx-doc.org/en/master/usage/extensions/napoleon.html
- https://numpydoc.readthedocs.io/en/latest/format.html
- Julia: the current link is good enough, but if needed https://docs.julialang.org/en/v1/stdlib/Markdown/#markdown_stdlib can be added as well
- R: is it https://roxygen2.r-lib.org/articles/rd.html ?
- Fortran and C++: https://www.doxygen.nl/manual/docblocks.html
- Rust: is it https://rust-lang.github.io/rfcs/1574-more-api-documentation-conventions.html ?