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

Commit

Permalink
Update docs about ruff vs. flake8.
Browse files Browse the repository at this point in the history
  • Loading branch information
clokep committed Dec 21, 2022
1 parent 7010a3d commit 14abf22
Showing 1 changed file with 2 additions and 2 deletions.
4 changes: 2 additions & 2 deletions docs/code_style.md
Original file line number Diff line number Diff line change
Expand Up @@ -10,7 +10,7 @@ The necessary tools are:

- [black](https://black.readthedocs.io/en/stable/), a source code formatter;
- [isort](https://pycqa.github.io/isort/), which organises each file's imports;
- [flake8](https://flake8.pycqa.org/en/latest/), which can spot common errors; and
- [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:
Expand All @@ -28,7 +28,7 @@ scripts-dev/lint.sh
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 `flake8` or `mypy`
development workflow. It is not, however, recommended to run `mypy`
on save as they take a while and can be very resource intensive.

## General rules
Expand Down

0 comments on commit 14abf22

Please sign in to comment.