search

rl-institut / smooth

Simulation framework for non-linear state-dependant energy systems
Other
6 stars 7 forks source link

Docstrings are missing in a lot of places #201

Closed Bachibouzouk closed 3 years ago

Bachibouzouk commented 4 years ago

A docstring will be displayed by the help() python builtin function. Right now there is some explanation for some function but it is done with comments instead of wrapping this text within """ """ (triple quotes strings)

Inspiration for docstrings template, based on oemof style docstrings

These docstrings can then automatically be added to the readthedocs documentation to improve code understanding.

Example on how to build the documentation from the docstring found in a module.

Bachibouzouk commented 4 years ago

PS: my aim is to suggest improvement by opening this issue, not to give anyone tasks :), feel free to close the issue if you decide you don't need it