[ADD] check_docs can find constructor parameters in __init__ #887
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Also added warning W9005 to indicate when constructor parameters are documented in both the class docstring and __init__ docstring.
Contributor
|
Thank you. |
PCManticore
pushed a commit
that referenced
this pull request
Jun 30, 2016
Also added warning W9005 to indicate when constructor parameters are documented in both the class docstring and __init__ docstring.
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
2 participants
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
This pull request adds support for looking for constructor parameter documentation in either the class or
__init__docstring. See #886 for the motivation behind this.This also adds a new warning (W9005) to indicate when constructor parameters are documented
in both the class docstring and
__init__docstring.This does not implement checking whether the parameters are consistently documented in either the class or
__init__docstring.Fixes #886