Skip to content

Commit

Permalink
Update docs to mention ruff instead of black + isort
Browse files Browse the repository at this point in the history
  • Loading branch information
jherland committed May 6, 2024
1 parent 2bb3fa6 commit a2c964c
Show file tree
Hide file tree
Showing 2 changed files with 7 additions and 8 deletions.
11 changes: 5 additions & 6 deletions CONTRIBUTING.md
Original file line number Diff line number Diff line change
Expand Up @@ -77,9 +77,9 @@ nox -R # Run all available sessions, while reusing virtualenvs (i.e.
nox -s tests # Run unit tests on supported Python versions (that are available)
nox -s tests-3.7 # Run unit tests on Python v3.7 (assuming it is available locally)
nox -s integration_tests-3.11 # Run integration tests on Python 3.11
nox -s lint # Run linters (mypy + ruff) on all supported Python versions
nox -s format # Check formatting (isort + black)
nox -s reformat # Fix formatting (isort + black)
nox -s lint # Run linters (mypy + ruff check) on all supported Python versions
nox -s format # Check formatting (ruff format)
nox -s reformat # Fix formatting (ruff format)
```

If you want to run a command individually, the corresponding session is defined inside
Expand All @@ -90,9 +90,8 @@ commands will work:
pytest # Run unit tests
pytest -m integration # Run integration tests
mypy # Run static type checking
ruff check . # Run ruff
isort fawltydeps tests # Fix sorting of import statements
black . # Fix code formatting
ruff check . # Run ruff linter
ruff format . # Run ruff formatter
```

#### Shortcut: Nix
Expand Down
4 changes: 2 additions & 2 deletions docs/CodeDesign.md
Original file line number Diff line number Diff line change
Expand Up @@ -20,8 +20,8 @@ We value composability and functional style.

We want the code to be readable, testable and maintainable. That is why we use:

- code formatter `black` to unify the code style,
- `ruff` and `isort` for linting
- code formatter `ruff format` to unify the code style,
- `ruff check` for linting
- `mypy` for typecheck
- `pytest` for testing
to ensure this quality.
Expand Down

0 comments on commit a2c964c

Please sign in to comment.