I document my class initialization inside the class docstring, therefore pydocstyle complains about undocumented __init__ methods.
My solution idea
It would be great to have the ability to have a flag (for example --ignore-func) that would work for both functions, classes and class methods with maybe a regex. So for ignoring the __init__ the flag could be ``--ignore-fu
The function is a block of code defined with a name. We use functions whenever we need to perform the same task multiple times without writing the same code again. It can take arguments and returns the value.
A common-ish mistake for docstring author is to use the label of a parameter as opposed to the actual name. The error message in this scenario could be improved. Right now the parameter docstring is reported as missing. It could be something like "Parameter label (X) is used instead of name (Y)".
My problem
I document my class initialization inside the class docstring, therefore pydocstyle complains about undocumented
__init__methods.My solution idea
It would be great to have the ability to have a flag (for example
--ignore-func) that would work for both functions, classes and class methods with maybe a regex. So for ignoring the__init__the flag could be ``--ignore-fu