Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Ruff related chores #526

Merged
merged 2 commits into from
Nov 1, 2024
Merged

Ruff related chores #526

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
9054d51
chore: update README about Ruff
tuomas777 Oct 31, 2024
e43278a
chore: add Ruff commit to .git-blame-ignore-revs
tuomas777 Oct 31, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 2 additions & 0 deletions .git-blame-ignore-revs
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,2 @@
# style: run Ruff format, apply lint fixes and add noqas
7184905558c28ca84a0bd8b6b71e10fa5523ea08
15 changes: 6 additions & 9 deletions README.md
View file
Open in desktop
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