Add code documentation - Githubissues

rl-institut / simbev

MIT License

10 stars 4 forks source link

Add code documentation #77

Open mosc5 opened 2 years ago

mosc5 commented 2 years ago

Tasks:

[x] Research docstring conventions
[x] Decide on convention that fits our needs (typing, readthedocs, ...)
[ ] Write docstrings for existing classes and functions

mosc5 commented 1 year ago

https://numpydoc.readthedocs.io/en/latest/format.html