Skip to content
Snippets Groups Projects
Commit 14abf22d authored by Patrick Cloke's avatar Patrick Cloke
Browse files

Update docs about ruff vs. flake8.

parent 7010a3d0
No related branches found
No related tags found
No related merge requests found
...@@ -10,7 +10,7 @@ The necessary tools are: ...@@ -10,7 +10,7 @@ The necessary tools are:
- [black](https://black.readthedocs.io/en/stable/), a source code formatter; - [black](https://black.readthedocs.io/en/stable/), a source code formatter;
- [isort](https://pycqa.github.io/isort/), which organises each file's imports; - [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. - [mypy](https://mypy.readthedocs.io/en/stable/), a type checker.
Install them with: Install them with:
...@@ -28,7 +28,7 @@ scripts-dev/lint.sh ...@@ -28,7 +28,7 @@ scripts-dev/lint.sh
It's worth noting that modern IDEs and text editors can run these tools 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 automatically on save. It may be worth looking into whether this
functionality is supported in your editor for a more convenient 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. on save as they take a while and can be very resource intensive.
## General rules ## General rules
......
0% Loading or .
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment