mirrors/ruff
1
0
Fork 0
mirror of https://github.com/astral-sh/ruff.git synced 2025-08-03 18:28:24 +00:00
Code Issues Projects Releases Packages Wiki Activity Actions 3

Deduplicate information in configuration documentation (#7108)

Browse source
This commit is contained in:
dalgarno 2023-09-03 22:17:35 +01:00 • committed by GitHub
parent c7217e34d7
commit af189db5eb
No known key found for this signature in database
GPG key ID: 4AEE18F83AFDEB23
1 changed files with 5 additions and 8 deletions
Download patch file Download diff file Expand all files Collapse all files

13
docs/configuration.md
View file

@ -57,23 +57,20 @@ dummy-variable-rgx = "^(_+|(_+[a-zA-Z0-9_]*[a-zA-Z0-9]+?))$"
target-version = "py38"
```
As an example, the following would configure Ruff to: (1) enforce flake8-bugbear rules, in addition
to the defaults; (2) avoid enforcing line-length violations (`E501`); (3) avoid attempting to fix
flake8-bugbear (`B`) violations; and (3) ignore import-at-top-of-file violations (`E402`) in
`__init__.py` files:
As an example, the following would configure Ruff to:
```toml
[tool.ruff]
# Enable flake8-bugbear (`B`) rules.
# 1. Enable flake8-bugbear (`B`) rules, in addition to the defaults.
select = ["E", "F", "B"]
# Never enforce `E501` (line length violations).
# 2. Avoid enforcing line-length violations (`E501`)
ignore = ["E501"]
# Avoid trying to fix flake8-bugbear (`B`) violations.
# 3. Avoid trying to fix flake8-bugbear (`B`) violations.
unfixable = ["B"]
# Ignore `E402` (import violations) in all `__init__.py` files, and in `path/to/file.py`.
# 4. Ignore `E402` (import violations) in all `__init__.py` files, and in `path/to/file.py`.
[tool.ruff.per-file-ignores]
"__init__.py" = ["E402"]
"path/to/file.py" = ["E402"]