This PR adds numpy style docstrings to the code. This is a first step for building a usable documentation for the package. As a next step I intend to implement a propper docs page using sphinx.
Some of docstrings seem like extra boiler plate code but I added them anyway for automatic doc generating with sphinx.
gregordecristoforo
commented
1 year ago
This PR adds numpy style docstrings to the code. This is a first step for building a usable documentation for the package. As a next step I intend to implement a propper docs page using sphinx.
Some of docstrings seem like extra boiler plate code but I added them anyway for automatic doc generating with sphinx.