@@ -417,7 +417,8 @@ Code should be commented so as to be understood by other developers and users, e
Don't hesitate to state the source of your code.
When creating a new modules, class, method or function, add a [docstring](https://peps.python.org/pep-0257/) describing the purpose of the piece of code.
[PEP257](https://peps.python.org/pep-0257/) documents the conventions related to Python docstrings. This is especially important because in the near future, the documentation of the framework will be automatically generated with Sphinx, a tool that parses docstrings to generate the building blocks of a static website.
[PEP257](https://peps.python.org/pep-0257/) documents the conventions related to Python docstrings. The docstrings should follow the [Numpy documentation convention](https://numpydoc.readthedocs.io/en/latest/format.html#overview).
This is especially important because in the near future, the documentation of the framework will be automatically generated with Sphinx, a tool that parses docstrings to generate the building blocks of a static website.
## git
-**NEVER** add "all files" to git's tracked files (i.e. DO NOT use `git add .` or `git add -A` or `git add -A .`), for 2 reasons :
