Clarify documentation for --skip option #1689
Merged
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
The --skip option only handles full file paths or names of individual path components. For example, "foo/bar/baz.py" can be used to skip just that file. And "foo" would skip any files with that name and any files nested in directories with that name. On the other hand, "foo/bar" does *not* skip everything in the "foo/bar" directory. --skip-glob can be used to achieve this. Attempt to clarify the documentation to say that.
Jackenmen
reviewed
Mar 11, 2021
That file is actually generated (by https://github.com/PyCQA/isort/blob/develop/scripts/build_config_option_docs.py) 🙂 |
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.
The --skip option only handles full file paths or names of
individual path components.
For example, "foo/bar/baz.py" can be used to skip just that file.
And "foo" would skip any files with that name and any files nested
in directories with that name.
On the other hand, "foo/bar" does not skip everything in the
"foo/bar" directory. --skip-glob can be used to achieve this.
Attempt to clarify the documentation to say that.
Potential fix for #1685. Alternative to #1690.