summary refs log tree commit diff
path: root/docs
diff options
context:
space:
mode:
authorPatrick Cloke <patrickc@matrix.org>2022-12-21 13:08:20 -0500
committerPatrick Cloke <patrickc@matrix.org>2022-12-21 13:08:20 -0500
commit14abf22dd696129f69cd1a14b2044a4ca6cb1972 (patch)
tree97ee6ac70c48b21aacce64a84a1d9946a314bfb4 /docs
parentSwitch to ruff instead of flake8. (#14633) (diff)
downloadsynapse-14abf22dd696129f69cd1a14b2044a4ca6cb1972.tar.xz
Update docs about ruff vs. flake8.
Diffstat (limited to 'docs')
-rw-r--r--docs/code_style.md4
1 files changed, 2 insertions, 2 deletions
diff --git a/docs/code_style.md b/docs/code_style.md
index d65fda62d1..3aa7d0d741 100644
--- a/docs/code_style.md
+++ b/docs/code_style.md
@@ -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:
@@ -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