Skip to content
This repository was archived by the owner on Apr 26, 2024. It is now read-only.

Commit f4d2a73

Browse files
Remove outdated commands from the code style doc & point to the contributing guide. (#14773)
1 parent 5172c8c commit f4d2a73

File tree

2 files changed

+4
-12
lines changed

2 files changed

+4
-12
lines changed

changelog.d/14773.doc

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1 @@
1+
Remove duplicate commands from the Code Style documentation page; point to the Contributing Guide instead.

docs/code_style.md

Lines changed: 3 additions & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -13,23 +13,14 @@ The necessary tools are:
1313
- [ruff](https://github.com/charliermarsh/ruff), which can spot common errors; and
1414
- [mypy](https://mypy.readthedocs.io/en/stable/), a type checker.
1515

16-
Install them with:
17-
18-
```sh
19-
pip install -e ".[lint,mypy]"
20-
```
21-
22-
The easiest way to run the lints is to invoke the linter script as follows.
23-
24-
```sh
25-
scripts-dev/lint.sh
26-
```
16+
See [the contributing guide](development/contributing_guide.md#run-the-linters) for instructions
17+
on how to install the above tools and run the linters.
2718

2819
It's worth noting that modern IDEs and text editors can run these tools
2920
automatically on save. It may be worth looking into whether this
3021
functionality is supported in your editor for a more convenient
3122
development workflow. It is not, however, recommended to run `mypy`
32-
on save as they take a while and can be very resource intensive.
23+
on save as it takes a while and can be very resource intensive.
3324

3425
## General rules
3526

0 commit comments

Comments
 (0)