-
Notifications
You must be signed in to change notification settings - Fork 3
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Need a way to avoid adding docstring for __init__ #15
Comments
This would be a breaking change due to previous disables people have used not working anymore for magic methods. Before releasing that it would probably be worthwhile to consider the other rule codes. These should be straight forward to implement based on the linked PR. The ones I would consider are:
I would also create a shared function which determines whether a method is a magic method somewhere |
@jdkandersson To my mind, For instance, Google styleguide states:
So, I think there are 3 cases:
What do you think about the paragraph in Google styleguide? |
I think it is a fair request to have a specific rule to target |
Currently if
__init__
does not have a docstring. We get this error:DCO010 docstring should be defined for a function/ method/ class, more information: https://github.com/jdkandersson/flake8-docstrings-complete#fix-dco010
.Need an ability to avoid adding docstring for
__init__
.If this linter is able to detect
__init__
and other dunder/magic methods, then it can be added as a new DOC rule and it can be ignored either by flake8 or by the tool itself.The text was updated successfully, but these errors were encountered: