DOC: declare numpy as the docstring style

#339
psyinfra · Oct 20, 2023 · 8676da3 · 8676da3
1 parent 9165a08
commit 8676da3
Showing 1 changed file with 2 additions and 2 deletions.
diff --git a/README.md b/README.md
@@ -61,8 +61,8 @@ sections describe conventions followed in this project, additionally to the
 [PEP 8 Style Guide](https://peps.python.org/pep-0008/).
 
 #### The Complete Code Base:
-- All classes, functions and properties (including tests) have a doc-string that
-  describes their functionality.
+- All classes, functions and properties (including tests) have a docstring
+  following the [Numpy standard](https://numpydoc.readthedocs.io/en/latest/format.html).
 - All functions have type hinting (including explicit return type for `None`).
 - The code conforms to [PEP 8](https://peps.python.org/pep-0008/).