Move constructor docu to class' docstring
The constructor method __init__
can either be described in the main docstring (the one just following the def
) or with the __init__
method. See class ExampleError(Exception)
on Example Google Style Python Docstrings.
When using the __init__
method, Sphinx needs 'special-members'
in autodoc_default_flags
, otherwise there is no docu for dunder methods.
This however generates far to much unwanted docu for us (see for example woohoo_pdns.meta
).
Documentation of the constructor should therefore be in the main docstring.
Edited by Andreas