Skip to content

Commit c9a0460

Browse files
committed
Update quick start to reflect new linting
1 parent a55f7cc commit c9a0460

File tree

1 file changed

+8
-7
lines changed

1 file changed

+8
-7
lines changed

docs/developers_guide/quick_start.md

Lines changed: 8 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -587,13 +587,14 @@ Polaris complies with the coding conventions of
587587
guidelines, the easiest way to stay in compliance as a developer writing new
588588
code or modifying existing code is to use a PEP8 style checker. When you create
589589
a load script, we automatically install [pre-commit](https://pre-commit.com/),
590-
a tools that helps to enforce this standard by checking your code each time you
591-
make a commit. It will tell you about various types of problems it finds.
592-
Internally, it uses [flake8](https://flake8.pycqa.org/en/latest/) to check PEP8
593-
compliance, [isort](https://pycqa.github.io/isort/) to sort, check and format
594-
imports, [flynt](https://github.com/ikamensh/flynt) to change any format
595-
strings to f-strings, and [mypy](https://mypy-lang.org/) to check for
596-
consistent variable types. An example error might be:
590+
a tool that helps to enforce this standard by checking your code each time you
591+
make a commit. It will tell you about various types of problems it finds.
592+
Internally, `pre-commit` uses [ruff](https://docs.astral.sh/ruff/) to perform
593+
various checks, such as enforcing PEP8 compliance and sorting and formatting
594+
imports. Additionally, `pre-commit` uses
595+
[flynt](https://github.com/ikamensh/flynt) to update any old-style format
596+
strings to f-strings and [mypy](https://mypy-lang.org/) to check for consistent
597+
variable types. An example error might be:
597598

598599
```bash
599600
example.py:77:1: E302 expected 2 blank lines, found 1

0 commit comments

Comments
 (0)