-
-
Notifications
You must be signed in to change notification settings - Fork 1.2k
Respect docstring-min-length in docparams extension #10104
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
Merged
Merged
Changes from all commits
Commits
Show all changes
4 commits
Select commit
Hold shift + click to select a range
3da2268
Respect docstring-min-length in docparams extension
berkersal b41cf5e
Functional tests for docparams extension docstring-min-length fix
berkersal aea598e
Changelog for docparams extension docstring-min-length fix
berkersal d1ad30d
[pre-commit.ci] auto fixes from pre-commit.com hooks
pre-commit-ci[bot] File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
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
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,3 @@ | ||
Fix false positive for `missing-raises-doc` and `missing-yield-doc` when the method length is less than docstring-min-length. | ||
|
||
Refs #10104 |
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
10 changes: 10 additions & 0 deletions
10
tests/functional/ext/docparams/raise/missing_raises_doc_required_min_length.py
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
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,10 @@ | ||
"""Tests for missing-raises-doc for non-specified style docstrings | ||
with accept-no-raise-doc = no and docstring-min-length = 3 | ||
""" | ||
# pylint: disable=invalid-name, broad-exception-raised | ||
|
||
# Example of a function that is less than 'docstring-min-length' config option | ||
# No error message is emitted. | ||
def test_skip_docstring_min_length(): | ||
"""function is too short and is missing raise documentation""" | ||
raise Exception |
7 changes: 7 additions & 0 deletions
7
tests/functional/ext/docparams/raise/missing_raises_doc_required_min_length.rc
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
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,7 @@ | ||
[MAIN] | ||
load-plugins = pylint.extensions.docparams | ||
|
||
[BASIC] | ||
accept-no-raise-doc=no | ||
docstring-min-length=3 | ||
no-docstring-rgx=^$ |
10 changes: 10 additions & 0 deletions
10
tests/functional/ext/docparams/yield/missing_yield_doc_required_min_length.py
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
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,10 @@ | ||
"""Tests for missing-yield-doc for non-specified style docstrings | ||
with accept-no-yields-doc = no and docstring-min-length = 3 | ||
""" | ||
# pylint: disable=invalid-name | ||
|
||
# Example of a function that is less than 'docstring-min-length' config option | ||
# No error message is emitted. | ||
def test_skip_docstring_min_length(): | ||
"""function is too short and is missing yield documentation""" | ||
yield None |
7 changes: 7 additions & 0 deletions
7
tests/functional/ext/docparams/yield/missing_yield_doc_required_min_length.rc
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
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,7 @@ | ||
[MAIN] | ||
load-plugins = pylint.extensions.docparams | ||
|
||
[BASIC] | ||
accept-no-yields-doc=no | ||
docstring-min-length=3 | ||
no-docstring-rgx=^$ |
Oops, something went wrong.
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.
Uh oh!
There was an error while loading. Please reload this page.