Skip to content

Commit a48d60a

Browse files
authored
Deprecate the --apply-format-changes option of check/all (#7964)
And update the development doc with preferred `check/all` options. Follow-up to #7962
1 parent b2a6af6 commit a48d60a

2 files changed

Lines changed: 7 additions & 2 deletions

File tree

check/all

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -58,6 +58,9 @@ for arg in "$@"; do
5858
extra_ruff_args=( --fix )
5959
;;
6060
--apply-format-changes)
61+
echo "Warning: option '--apply-format-changes' is deprecated." \
62+
"Please use '--fix' instead." >&2
63+
echo >&2
6164
extra_format_args=( --apply )
6265
;;
6366
-*)

docs/dev/development.md

Lines changed: 4 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -252,11 +252,13 @@ set the Python path and configuration arguments for you and cover more use cases
252252
- Run all continuous integration checks:
253253
254254
```bash
255-
./check/all [BASE_REVISION] [--only-changed-files] [--apply-format-changes]
255+
./check/all [BASE_REVISION] [--changed] [--fix]
256256
```
257257
258-
If `--only-changed-files` is set, checks that can will focus down to
258+
If the `--changed` option is set, checks that can will focus down to
259259
just files that were changed (trading accuracy for speed).
260+
The option `--fix` will apply safe corrections from linter and
261+
formatter tools to address problems detected in the code.
260262
261263
In the above, `[BASE_REVISION]` controls what commit is being compared
262264
against for an incremental check (e.g., in order to determine which files changed).

0 commit comments

Comments
 (0)