Skip to content

Commit

Permalink
chore: update README about Ruff
Browse files Browse the repository at this point in the history
  • Loading branch information
tuomas777 committed Nov 1, 2024
1 parent 7184905 commit 49488ef
Showing 1 changed file with 6 additions and 9 deletions.
15 changes: 6 additions & 9 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -157,17 +157,14 @@ This repository contains `requirements*.in` and corresponding `requirements*.txt

## Code format

This project uses
[`black`](https://github.com/ambv/black),
[`flake8`](https://gitlab.com/pycqa/flake8) and
[`isort`](https://github.com/pycqa/isort)
for code formatting and quality checking. Project follows the basic
black config, without any modifications.
This project uses [Ruff](https://docs.astral.sh/ruff/) for code formatting and quality checking.

Basic `black` commands:
Basic `ruff` commands:

* To let `black` do its magic: `black .`
* To see which files `black` would change: `black --check .`
* lint: `ruff check`
* apply safe lint fixes: `ruff check --fix`
* check formatting: `ruff format --check`
* format: `ruff format`

[`pre-commit`](https://pre-commit.com/) can be used to install and
run all the formatting tools as git hooks automatically before a
Expand Down

0 comments on commit 49488ef

Please sign in to comment.