google_docstring_example.ExampleError Class Reference

Inheritance diagram for google_docstring_example.ExampleError:

Public Member Functions
def	__init__

Public Attributes
	msg
	code

Detailed Description

Exceptions are documented in the same way as classes.

The __init__ method may be documented in either the class level
docstring, or as a docstring on the __init__ method itself.

Either form is acceptable, but the two should not be mixed. Choose one
convention to document the __init__ method and be consistent with it.

Note:
  Do not include the `self` parameter in the ``Args`` section.

Args:
  msg (str): Human readable string describing the exception.
  code (int, optional): Error code, defaults to 2.

Attributes:
  msg (str): Human readable string describing the exception.
  code (int): Exception error code.

---

The documentation for this class was generated from the following file:

• docs/style_standards/google_docstring_example.py