pints
pints copied to clipboard
Check all docstrings start with a single line explanation.
https://www.python.org/dev/peps/pep-0257/#what-is-a-docstring
Multi-line docstrings consist of a summary line just like a one-line docstring, followed by a blank line, followed by a more elaborate description. The summary line may be used by automatic indexing tools; it is important that it fits on one line and is separated from the rest of the docstring by a blank line. The summary line may be on the same line as the opening quotes or on the next line.
It'd be good to check that (1) our code follows this convention and (2) that everyone is aware of it