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

Remove outdated commands from the code style documentation, point to the contributing guide instead #14773

Merged
merged 5 commits into from
Jan 11, 2023
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
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
1 change: 1 addition & 0 deletions changelog.d/14773.doc
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
Remove duplicate commands from the Code Style documentation page; point to the Contributing Guide instead.
15 changes: 3 additions & 12 deletions docs/code_style.md
Original file line number Diff line number Diff line change
Expand Up @@ -13,23 +13,14 @@ The necessary tools are:
- [ruff](https://github.com/charliermarsh/ruff), which can spot common errors; and
- [mypy](https://mypy.readthedocs.io/en/stable/), a type checker.

Install them with:

```sh
pip install -e ".[lint,mypy]"
```

The easiest way to run the lints is to invoke the linter script as follows.

```sh
scripts-dev/lint.sh
```
See [the contributing guide](development/contributing_guide.md#run-the-linters) for instructions
on how to install the above tools and run the linters.

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

## General rules

Expand Down