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

Commit

Permalink
Remove outdated commands from the code style doc & point to the contr…
Browse files Browse the repository at this point in the history
…ibuting guide. (#14773)
  • Loading branch information
anoadragon453 authored Jan 11, 2023
1 parent 5172c8c commit f4d2a73
Show file tree
Hide file tree
Showing 2 changed files with 4 additions and 12 deletions.
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

0 comments on commit f4d2a73

Please sign in to comment.