New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Revise docstrings #45
Comments
This is now the parent issue for the revision of docstring. @miguelparadacontzen takes care about structure, completeness, and formatting of docstrings and provides as much information as possible. Remaining tasks to complete docstrings will be assigned to @nesnoj and @gplssm. Let's therefore create individual issues per file or module and keep track of them along the milestone. |
In order to use work by @miguelparadacontzen irregardless of unfinished polishing of docstrings (i.e. #202) the branch features/clean-documentation will be merged into dev. This brings a properly building API/class documentation.
|
After renaming, ding0 runs properly. Integrity of resulting data in terms of being identical to dev branch was tested successfully on grid ids 11,45,54. This issue will be closed because API docs build now and the long living branch |
Get all docstrings right
The text was updated successfully, but these errors were encountered: