Skip to content

Commit 793cac2

Browse files
authoredJan 20, 2023
Merge pull request #2074 from micahjsmith/patch-1
Add more docs about filter-files option
2 parents 03a9949 + 45b3166 commit 793cac2

File tree

1 file changed

+6
-5
lines changed

1 file changed

+6
-5
lines changed
 

‎docs/configuration/options.md

+6-5
Original file line numberDiff line numberDiff line change
@@ -57,7 +57,7 @@ Force specific imports to the top of their appropriate section.
5757

5858
## Skip
5959

60-
Files that isort should skip over. If you want to skip multiple files you should specify twice: --skip file1 --skip file2. Values can be file names, directory names or file paths. To skip all files in a nested path use --skip-glob.
60+
Files that isort should skip over. If you want to skip multiple files you should specify twice: `--skip file1 --skip file2`. Values can be file names, directory names or file paths. To skip all files in a nested path, use [`--skip-glob`](#skip-glob). To even skip matching files that have been specified on the command line, use [`--filter-files`](#filter-files).
6161

6262
**Type:** List of Strings
6363
**Default:** `('.bzr', '.direnv', '.eggs', '.git', '.hg', '.mypy_cache', '.nox', '.pants.d', '.svn', '.tox', '.venv', '__pypackages__', '_build', 'buck-out', 'build', 'dist', 'node_modules', 'venv')`
@@ -87,7 +87,7 @@ skip = [".gitignore", ".dockerignore"]
8787

8888
## Extend Skip
8989

90-
Extends --skip to add additional files that isort should skip over. If you want to skip multiple files you should specify twice: --skip file1 --skip file2. Values can be file names, directory names or file paths. To skip all files in a nested path use --skip-glob.
90+
Extends --skip to add additional files that isort should skip over. If you want to skip multiple files you should specify twice: --skip file1 --skip file2. Values can be file names, directory names or file paths. To skip all files in a nested path, use [`--skip-glob`](#skip-glob). To even skip matching files that have been specified on the command line, use [`--filter-files`](#filter-files).
9191

9292
**Type:** List of Strings
9393
**Default:** `frozenset()`
@@ -116,7 +116,7 @@ extend_skip = [".md", ".json"]
116116

117117
## Skip Glob
118118

119-
Files that isort should skip over.
119+
Files that isort should skip over. To even skip matching files that have been specified on the command line, use [`--filter-files`](#filter-files).
120120

121121
**Type:** List of Strings
122122
**Default:** `frozenset()`
@@ -147,7 +147,7 @@ skip_glob = ["docs/*"]
147147

148148
## Extend Skip Glob
149149

150-
Additional files that isort should skip over (extending --skip-glob).
150+
Additional files that isort should skip over (extending --skip-glob). To even skip matching files that have been specified on the command line, use [`--filter-files`](#filter-files).
151151

152152
**Type:** List of Strings
153153
**Default:** `frozenset()`
@@ -177,7 +177,8 @@ extend_skip_glob = ["my_*_module.py", "test/*"]
177177

178178
## Skip Gitignore
179179

180-
Treat project as a git repository and ignore files listed in .gitignore.
180+
Treat project as a git repository and ignore files listed in .gitignore. To even skip matching files that have been specified on the command line, use [`--filter-files`](#filter-files).
181+
181182
NOTE: This requires git to be installed and accessible from the same shell as isort.
182183

183184
**Type:** Bool

0 commit comments

Comments
 (0)
Please sign in to comment.