Document code

[JakubTesarek]

Write code documentation to make it easier to navigate the project for potential contributors.

Documentation should include both pydoc comments as well as general overview of most important parts in developer documentation.

After it’s done add note to contributors file that it’s required to document all new functions.

Study sources:

• https://realpython.com/documenting-python-code/
• https://www.python.org/dev/peps/pep-0257/
• https://github.com/google/styleguide/blob/gh-pages/pyguide.md#38-comments-and-docstrings
• https://www.youtube.com/watch?v=2xWhaALHTvU
• https://www.sphinx-doc.org/en/1.5/tutorial.html

[JakubTesarek]

https://realpython.com/documenting-python-code/ https://www.python.org/dev/peps/pep-0257/ https://github.com/google/styleguide/blob/gh-pages/pyguide.md#38-comments-and-docstrings