Skip to content
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

Clarify documentation for --skip option #1689

Merged
merged 3 commits into from
Mar 12, 2021
Merged

Clarify documentation for --skip option #1689

merged 3 commits into from
Mar 12, 2021

Conversation

gofr
Copy link
Contributor

@gofr gofr commented Mar 11, 2021

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.

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.
Copy link

@Jackenmen Jackenmen left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This needs to be updated in the docs/configuration/options.md as well

@gofr
Copy link
Contributor Author

gofr commented Mar 11, 2021

This needs to be updated in the docs/configuration/options.md as well

That file is actually generated (by https://github.com/PyCQA/isort/blob/develop/scripts/build_config_option_docs.py) 🙂

@timothycrosley timothycrosley merged commit a3afea9 into PyCQA:develop Mar 12, 2021
sebp added a commit to sebp/scikit-survival that referenced this pull request Jun 24, 2021
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants