kas-lab / rosa

A knowledge-based framework for Robot Self-adaptation (ROSA)
https://kas-lab.github.io/rosa/
Apache License 2.0
0 stars 0 forks source link

Document code #64

Open Rezenders opened 11 months ago

Rezenders commented 11 months ago

Include pydoc strings to methods

Rezenders commented 10 months ago

https://sphinx-rtd-tutorial.readthedocs.io/en/latest/docstrings.html https://stackoverflow.com/questions/33945261/how-to-specify-multiple-return-types-using-type-hints https://stackoverflow.com/questions/37570679/how-do-i-document-rtype-for-a-function-that-returns-multiple-possible-data-typ https://peps.python.org/pep-0483/ https://peps.python.org/pep-0484/ https://docs.python.org/3/library/typing.html