Skip to content

replace yapf reference with instruction to use 'ruff format' #695

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

Merged
sjvrijn merged 3 commits into from
Nov 17, 2025
Merged

replace yapf reference with instruction to use 'ruff format' #695

Show file tree
Hide file tree
Changes from 2 commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
286be72
replace yapf reference with instruction to use 'ruff format'
sjvrijn Sep 8, 2025
ab31a4b
update changelog
sjvrijn Sep 8, 2025
72ac687
consistently use ruff <command> .; ignore rule COM812
sjvrijn Nov 17, 2025
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 CHANGELOG.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -8,6 +8,8 @@

### Changed

* Recommend `ruff format` instead of `yapf` for fixing code style readability [#695](https://github.com/NLeSC/python-template/pull/695)

### Removed

## 0.6.1
Expand Down
8 changes: 6 additions & 2 deletions template/{% if AddDevDoc %}README.dev.md{% endif %}.jinja
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -65,7 +65,7 @@ coverage report
{%- if AddLinting -%}
## Running linters locally

For linting and sorting imports we will use [ruff](https://beta.ruff.rs/docs/). Running the linters requires an
For linting and sorting imports we will use [ruff](https://docs.astral.sh/ruff/). Running the linters requires an
activated virtual environment with the development tools installed.

```shell
Expand All @@ -76,7 +76,11 @@ ruff check .
ruff check . --fix
```

To fix readability of your code style you can use [yapf](https://github.com/google/yapf).
It also provides a command to fix readability of your code style:

```shell
ruff format .
```
{%- endif -%}

{%- if AddPreCommit -%}
Expand Down