Skip to content
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
takos22 opened this issue May 13, 2021 · 1 comment
Open

Add flag to ignore some functions, classes or class methods #537

takos22 opened this issue May 13, 2021 · 1 comment
Labels
good first issue help wanted Minor (New Feature) Waiting for Assignee This issue has been triaged as a good idea, waiting for a volunteer to implement

Comments

@takos22
Copy link

takos22 commented May 13, 2021

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.

@sambhav sambhav added good first issue Minor (New Feature) Waiting for Assignee This issue has been triaged as a good idea, waiting for a volunteer to implement help wanted labels May 17, 2021
@KaleabTessera
Copy link

Would be a great feature!

Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Labels
good first issue help wanted Minor (New Feature) Waiting for Assignee This issue has been triaged as a good idea, waiting for a volunteer to implement
Projects
None yet
Development

No branches or pull requests

3 participants