remove redundant sentences from general PISA conventions and add link…

… to them in root readme
icecube · Aug 13, 2024 · 745b6d0 · 745b6d0
1 parent f739ae4
commit 745b6d0
Show file tree

Hide file tree

Showing 2 changed files with 1 addition and 1 deletion.
diff --git a/README.md b/README.md
@@ -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.

diff --git a/pisa/general_conventions.md b/pisa/general_conventions.md
@@ -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