From a2a8eb368a799f96f7120a180c9f3dd49b99888d Mon Sep 17 00:00:00 2001 From: Michael Chouinard Date: Thu, 20 Jun 2024 15:05:44 -0400 Subject: [PATCH] Adjust docs --- docs/app/formatting-and-linting.md | 6 +----- 1 file changed, 1 insertion(+), 5 deletions(-) diff --git a/docs/app/formatting-and-linting.md b/docs/app/formatting-and-linting.md index 59dff4d..d868051 100644 --- a/docs/app/formatting-and-linting.md +++ b/docs/app/formatting-and-linting.md @@ -16,13 +16,9 @@ When we run migrations via alembic, we autorun the formatters on the generated f Run `make lint` to run all of the linters. It's recommended you run the formatters first as they fix several linting issues automatically. -### Flake +### Ruff [ruff](https://flake8.pycqa.org/en/latest/) is used to enforce a set of best practices for our Python code. Configuration options can be found in [pyproject.toml - tool.ruff](/app/pyproject.toml). -We use two flake extensions: -* [bugbear](https://pypi.org/project/flake8-bugbear/) for finding likely bugs and design problems. -* [alfred](https://pypi.org/project/flake8-alfred/) for finding unsafe/obsolete symbols. - ### Mypy [mypy](https://mypy.readthedocs.io/en/stable/) is used to validate and enforce typechecking in python. Configuration options can be found in [pyproject.toml - tool.mypy](/app/pyproject.toml)