This repository was archived by the owner on Nov 3, 2023. It is now read-only.
This repository was archived by the owner on Nov 3, 2023. It is now read-only.
Add flag to ignore some functions, classes or class methods #537
Open
Description
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-func='.*\.__init__'
, with .*
for the class name, \.
to say that it's a class method and __init__
to ignore that method.