Skip to content

Commit ac58e48

Browse files
docs: Updating based on review comments
1 parent 7e11bad commit ac58e48

File tree

1 file changed

+13
-14
lines changed

1 file changed

+13
-14
lines changed

doc/source/coding-style/formatting-tools.rst

Lines changed: 13 additions & 14 deletions
Original file line numberDiff line numberDiff line change
@@ -14,14 +14,14 @@ cleaner root project directory.
1414
Ruff
1515
----
1616

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:
2525

2626
- Can be installed via ``pip install ruff``
2727

@@ -59,7 +59,7 @@ may look like this:
5959
"TD", # flake8-todos, https://docs.astral.sh/ruff/rules/#flake8-todos-td
6060
]
6161
ignore = [
62-
"rule_to_ignore", # list all rules that shall be ignored by the linter
62+
"TD003", # Missing issue link in TODOs comment
6363
]
6464
6565
[tool.ruff.lint.pydocstyle]
@@ -69,11 +69,10 @@ may look like this:
6969
combine-as-imports = true
7070
force-sort-within-sections = true
7171
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/>`__.
7776

7877

7978
The ``Add-license-headers`` pre-commit hook

0 commit comments

Comments
 (0)