Skip to content

Commit

Permalink
Adjust docs
Browse files Browse the repository at this point in the history
  • Loading branch information
chouinar committed Jun 20, 2024
1 parent 6144939 commit a2a8eb3
Showing 1 changed file with 1 addition and 5 deletions.
6 changes: 1 addition & 5 deletions docs/app/formatting-and-linting.md
Original file line number Diff line number Diff line change
Expand Up @@ -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)

0 comments on commit a2a8eb3

Please sign in to comment.