Close #147. Cleans up docstrings from public (mostly) functions and methods. We can cleanup private ones later if we decide to autodoc them. Here are the conventions I tried to follow.
Docstring line length = 79 per PEP8.
All docstrings start on the same line as the opening """ for consistency between one-line and multi-line docstrings and because VS Code's autoDocstring extension populates them this way (PEP257 doesn't specify for multi-line docstrings).
The docstring is a phrase ending in a period per PEP257.
Multi-line docstrings have a one-line summary sentence, followed by a blank line per PEP257.
Parameter docstrings are not sentences, i.e. are mostly lower case without a period.
Omit quotes around forward referenced classes in rtype, which is how autoDocstring extension does it.
Move any TODOs from inside docstrings to body of def.
Close #147. Cleans up docstrings from public (mostly) functions and methods. We can cleanup private ones later if we decide to autodoc them. Here are the conventions I tried to follow.
rtype, which is how autoDocstring extension does it.