From 36a857b9d5b4cb7dd019ec29c480595d054efce5 Mon Sep 17 00:00:00 2001 From: Sander van Rijn Date: Mon, 8 Sep 2025 12:08:29 +0200 Subject: [PATCH 1/2] replace yapf reference with instruction to use 'ruff format' --- template/{% if AddDevDoc %}README.dev.md{% endif %}.jinja | 8 ++++++-- 1 file changed, 6 insertions(+), 2 deletions(-) diff --git a/template/{% if AddDevDoc %}README.dev.md{% endif %}.jinja b/template/{% if AddDevDoc %}README.dev.md{% endif %}.jinja index a12eafcb..7f085d57 100644 --- a/template/{% if AddDevDoc %}README.dev.md{% endif %}.jinja +++ b/template/{% if AddDevDoc %}README.dev.md{% endif %}.jinja @@ -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 @@ -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 -%} From 2d2f52562b7f077beb7ecdb4684fd7b5e29fcf7f Mon Sep 17 00:00:00 2001 From: Sander van Rijn Date: Mon, 8 Sep 2025 12:38:25 +0200 Subject: [PATCH 2/2] update changelog --- CHANGELOG.md | 2 ++ 1 file changed, 2 insertions(+) diff --git a/CHANGELOG.md b/CHANGELOG.md index 19e06afa..c5a3e5b8 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -6,6 +6,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