Closed
Description
Problem
We need a class docstring and a constructor one. Right now we just have a class one.
Proposed solution
Conform to PEP257 convention here:
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.
Metadata
Metadata
Assignees
Labels
No labels