class documentation

class ExamplePEP526Class: (source)

View In Hierarchy

The summary line for a class docstring should fit on one line.

If the class has public attributes, they may be documented here in an Attributes section and follow the same formatting as a function's Args section. If napoleon_attr_annotations is True, types can be specified in the class body using PEP 526 annotations.

Instance Variable attr1 Description of attr1.
Instance Variable attr2 Description of attr2.
attr1: str = (source)

Description of attr1.

attr2: int = (source)

Description of attr2.