Format documentation strings according to standard
There are standards for Python documentation strings. One of them is numpydoc, and examples are at
and
https://python.plainenglish.io/how-to-write-numpy-style-docstrings-a092121403ba
There are standards for Python documentation strings. One of them is numpydoc, and examples are at
and
https://python.plainenglish.io/how-to-write-numpy-style-docstrings-a092121403ba
pydocstyle
can help with the checks, for example pydocstyle --convention=numpy
.
Ruff can probably do the same if told correctly.
This is hard work to do (cannot be done automatically I guess).
mentioned in commit bb5f1b71
mentioned in merge request !11 (merged)
Resolved through merge request !11 (merged)
closed