Make numpydoc lint --ignore ... parsing more robust
#560
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
Before, the only way to specify ignores is as: numpydoc lint filename --ignore EX01 SA01 and multiple invocations of the ignore flag overwrote one another. Instead, ignored checks are now specified as: numpydoc lint --ignore=EX01,SA01 filename The comma can also be whitespace: numpydoc lint --ignore="EX01 SA01" filename Multiple ignore flags work correctly: numpydoc lint --ignore EX01 --ignore SA01 filename
rossbar
approved these changes
May 24, 2024
There was a problem hiding this comment.
LGTM, though @stefmolin 's opinion would be the most valuable. Thanks @stefanv !
|
I should note that this is backward incompatible (but I don't think we've made a release with the needs to be rewritten as any of the following: |
|
I'm traveling now, but I will take a look when I'm back later this week. |
stefmolin
requested changes
Jun 1, 2024
| @@ -100,8 +101,6 @@ def _parse_config(s): | |||
| ) | |||
| lint_parser.add_argument( | |||
| "--ignore", | |||
| type=str, | |||
| nargs="*", | |||
| help=( | |||
There was a problem hiding this comment.
I think we should indicate how this can be used in the help now that there are multiple options.
Co-authored-by: Stefanie Molin <24376333+stefmolin@users.noreply.github.com>
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
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.
Before, the only way to specify ignores is as:
and multiple invocations of the ignore flag overwrote one another.
Instead, ignored checks are now specified as:
The comma can also be whitespace:
Multiple ignore flags work correctly:
@stefmolin Would you be willing to take a look?