class Control:
"""This class reads all the inputs on the box. If box is not available then use the keyboard."""
This comes with a number of benefits with regards to tooling.
For example beforehand if we look at something like help(Control) we get no comment, whereas with my suggested change we get that documentation from the docstring from the tooling.
Beyond this there are a number of tooling related benefits from using the docstrings directly, mostly that you can automatically build a webpage of the documentation of your project by putting some documentation in these docstrings. There's tools like sphinx that does this.
https://github.com/JamesDevJim/game-zulu/blob/9bf97d92194ff8e7d61785aa535806c37a14003a/shared/control.py#L94-L96
Can be re-written as follows:
This comes with a number of benefits with regards to tooling.
For example beforehand if we look at something like
help(Control)
we get no comment, whereas with my suggested change we get that documentation from the docstring from the tooling.Beyond this there are a number of tooling related benefits from using the docstrings directly, mostly that you can automatically build a webpage of the documentation of your project by putting some documentation in these docstrings. There's tools like sphinx that does this.