Skip to content
GitLab
Explore
Sign in
Primary navigation
Search or go to…
Project
synapse
Manage
Activity
Members
Labels
Plan
Issues
Issue boards
Milestones
Code
Merge requests
Repository
Branches
Commits
Tags
Repository graph
Compare revisions
Build
Pipelines
Jobs
Pipeline schedules
Artifacts
Deploy
Releases
Container Registry
Model registry
Monitor
Service Desk
Analyze
Value stream analytics
Contributor analytics
CI/CD analytics
Repository analytics
Model experiments
Help
Help
Support
GitLab documentation
Compare GitLab plans
Community forum
Contribute to GitLab
Provide feedback
Keyboard shortcuts
?
Snippets
Groups
Projects
Show more breadcrumbs
Maunium
synapse
Commits
14abf22d
Commit
14abf22d
authored
2 years ago
by
Patrick Cloke
Browse files
Options
Downloads
Patches
Plain Diff
Update docs about ruff vs. flake8.
parent
7010a3d0
No related branches found
No related tags found
No related merge requests found
Changes
1
Hide whitespace changes
Inline
Side-by-side
Showing
1 changed file
docs/code_style.md
+2
-2
2 additions, 2 deletions
docs/code_style.md
with
2 additions
and
2 deletions
docs/code_style.md
+
2
−
2
View file @
14abf22d
...
...
@@ -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
...
...
This diff is collapsed.
Click to expand it.
Preview
0%
Loading
Try again
or
attach a new file
.
Cancel
You are about to add
0
people
to the discussion. Proceed with caution.
Finish editing this message first!
Save comment
Cancel
Please
register
or
sign in
to comment