@@ -14,14 +14,14 @@ cleaner root project directory.
14
14
Ruff
15
15
----
16
16
17
- | `Ruff`_ is a Python linter and code formatter written in Rust.
18
- | It aims to be orders of magnitude faster than alternative tools while integrating more
19
- functionality behind a single, common interface.
20
- | Ruff can therefore be used to replace the previously preferred alternatives that were
21
- `Flake8`_ (natively re-implementing its popular plugins), `Black`_ and `isort`_: It
22
- provides drop-in parity with these tools, while executing tens or hundreds of times faster.
23
- It is actively developed and used in major open-source projects.
24
- | In addition, it offers the following features and advantages:
17
+ `Ruff `_ is a Python linter and code formatter written in Rust. It aims to be
18
+ orders of magnitude faster than alternative tools while integrating more
19
+ functionality behind a single, common interface. Ruff can therefore be used
20
+ to replace the previously preferred alternatives that were ` Flake8 `_
21
+ (natively re-implementing its popular plugins), `Black `_ and `isort `_.
22
+
23
+ It is actively developed, used in major open-source projects, and offers the following
24
+ features and advantages:
25
25
26
26
- Can be installed via ``pip install ruff ``
27
27
@@ -59,7 +59,7 @@ may look like this:
59
59
"TD", # flake8-todos, https://docs.astral.sh/ruff/rules/#flake8-todos-td
60
60
]
61
61
ignore = [
62
- "rule_to_ignore ", # list all rules that shall be ignored by the linter
62
+ "TD003 ", # Missing issue link in TODOs comment
63
63
]
64
64
65
65
[tool.ruff.lint.pydocstyle]
@@ -69,11 +69,10 @@ may look like this:
69
69
combine-as-imports = true
70
70
force-sort-within-sections = true
71
71
72
- | Linting and formatting rules shall be added step by step when migrating a project to Ruff,
73
- gradually resolving the triggered errors.
74
- | For more information about configuring Ruff, as well as a complete description of the available
75
- rules and settings, please refer to the `tool's documentation
76
- <https://docs.astral.sh/ruff/configuration/>`__.
72
+ Linting and formatting rules shall be added step by step when migrating a project to Ruff,
73
+ gradually resolving the triggered errors. For more information about configuring Ruff, as
74
+ well as a complete description of the available rules and settings, please refer to the
75
+ `tool's documentation <https://docs.astral.sh/ruff/configuration/ >`__.
77
76
78
77
79
78
The ``Add-license-headers `` pre-commit hook
0 commit comments