This repository has been archived by the owner on Nov 3, 2023. It is now read-only.
Skip function arguments prefixed with _ in D417 check
#440
Conversation
This file contains 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
|
@Nurdok review please :) |
Nurdok
suggested changes
Dec 24, 2019
src/pydocstyle/checker.py
Outdated
| @@ -764,6 +764,9 @@ def _check_missing_args(docstring_args, definition): | |||
| # positional argument as it is `cls` or `self` | |||
| if definition.kind == 'method' and not definition.is_static: | |||
| function_args = function_args[1:] | |||
| # Filtering out any arguments prefixed with `_` marking them | |||
| # as private. | |||
| function_args = [arg for arg in function_args if not arg.startswith("_")] | |||
There was a problem hiding this comment.
Can you extract this logic to a function? e.g., is_def_arg_private. The code will have clearer intent (if not is_def_arg_private(arg)) and can be reused.
|
Please also add a release notes line. |
These arguments have been marked private. As such, it should be okay for the checker to not validate their existence in the docstring,
|
@Nurdok done. Sorry for the late update. Holiday time. |
|
@Nurdok bump |
Nurdok
approved these changes
Feb 29, 2020
Sign up for free
to subscribe to this conversation on GitHub.
Already have an account?
Sign in.
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.
These arguments have been marked private. As such,
it should be okay for the checker to not validate their
existence in the docstring,
Thanks for submitting a PR!
Please make sure to check for the following items:
If you've added an error code or changed an error code behavior,
you should probably add or change a test case file under
tests/test_cases/and addit to the list under
tests/test_definitions.py.If you've added or changed a command line option,
you should probably add or change a test in
tests/test_integration.py.Make sure to include the PR number after you open and get one.
Please don't get discouraged as it may take a while to get a review.
Fixes #438