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.

Sign up for GitHub

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

Add default exclusions and inclusions to docs #4432

Open
wants to merge 2 commits into
base: main
Choose a base branch
from
Open

Add default exclusions and inclusions to docs #4432

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
8ce1f14
Add default exclusions and inclusions to docs
AshSta512 Aug 8, 2024
8eef97b
[pre-commit.ci] auto fixes from pre-commit.com hooks
pre-commit-ci[bot] Aug 8, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
5 changes: 5 additions & 0 deletions docs/usage_and_configuration/the_basics.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -296,6 +296,9 @@ recursive searches. An empty value means no paths are excluded. Use forward slas
directories on all platforms (Windows, too). By default, Black also ignores all paths
listed in `.gitignore`. Changing this value will override all default exclusions.

Default Exclusions:
`['.direnv', '.eggs', '.git', '.hg', '.ipynb_checkpoints', '.mypy_cache', '.nox', '.pytest_cache', '.ruff_cache', '.tox', '.svn', '.venv', '.vscode', '__pypackages__', '_build', 'buck-out', 'build', 'dist', 'venv'] `

If the regular expression contains newlines, it is treated as a
[verbose regular expression](https://docs.python.org/3/library/re.html#re.VERBOSE). This
is typically useful when setting these options in a `pyproject.toml` configuration file;
Expand Down Expand Up @@ -324,6 +327,8 @@ recursive searches. An empty value means all files are included regardless of th
Use forward slashes for directories on all platforms (Windows, too). Overrides all
exclusions, including from `.gitignore` and command line options.

Default Inclusions: `['.pyi', '.ipynb']`

#### `-W`, `--workers`

When _Black_ formats multiple files, it may use a process pool to speed up formatting.
Expand Down
Loading