Skip to content

Commit

Permalink
Merge pull request #805 from thehrh/add_conventions_link_to_root_readme
Browse files Browse the repository at this point in the history
Add link to general PISA conventions in root readme
  • Loading branch information
JanWeldert authored Aug 14, 2024
2 parents 8acdf74 + 745b6d0 commit a752eaf
Show file tree
Hide file tree
Showing 2 changed files with 1 addition and 1 deletion.
1 change: 1 addition & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -10,6 +10,7 @@
[Installation](INSTALL.md) |
[Documentation](https://icecube.github.io/pisa/) |
[Terminology](pisa/glossary.md) |
[Conventions](pisa/general_conventions.md) |
[License](LICENSE)

PISA is a software written to analyze the results (or expected results) of an experiment based on Monte Carlo simulation.
Expand Down
1 change: 0 additions & 1 deletion pisa/general_conventions.md
Original file line number Diff line number Diff line change
Expand Up @@ -42,7 +42,6 @@ Docstrings should be formatted according to the NumPy/SciPy convention.
* [NumPy/SciPy documentation style guide](https://numpydoc.readthedocs.io/en/latest/format.html#docstring-standard)
* [Example NumPy docstrings in code](http://sphinxcontrib-napoleon.readthedocs.io/en/latest/example_numpy.html)
* [Recommonmark translates markdown into reST](http://recommonmark.readthedocs.io/en/latest/auto_structify.html)
* Since all documentation will be run through Sphinx using the Napoleon and Recommonmark extensions, the final arbiter on whether a docstring is formatted correctly is the output generated using these. Good information for making nice docstrings can be found in both [Napoleon](http://sphinxcontrib-napoleon.readthedocs.io/)

## Standalone files

Expand Down

0 comments on commit a752eaf

Please sign in to comment.