Join GitHub today
GitHub is home to over 31 million developers working together to host and review code, manage projects, and build software together.Sign up
Revise docstrings #9
State of existing docstrings
(1) no docstring
Check, revise and ask for support if necessary.
There was an open question at the meeting, where to write the docstring of a class. In pep257 I found:
"The docstring for a class should summarize its behavior and list the public methods and instance variables. If the class is intended to be subclassed, and has an additional interface for subclasses, this interface should be listed separately (in the docstring). The class constructor should be documented in the docstring for its init method. Individual methods should be documented by their own docstring."