exception documentation

class ExampleError(Exception): (source)

Constructor: ExampleError(msg, code)

View In Hierarchy

Exceptions are documented in the same way as classes.

The __init__ method should be documented as a docstring on the __init__ method.

Note

Do not include the self parameter in the Args section.

Parameters
msgHuman readable string describing the exception.
codeError code.
Method __init__ Undocumented
Instance Variable code Exception error code.
Instance Variable msg Human readable string describing the exception.
def __init__(self, msg, code): (source)

Undocumented

Exception error code.

Human readable string describing the exception.