Skip to content

Commit

Permalink
[docs] Document that /format is disabled (wpilibsuite#7810)
Browse files Browse the repository at this point in the history
Add instructions for manual workarounds
  • Loading branch information
sciencewhiz authored and spacey-sooty committed Feb 26, 2025
1 parent e00b7ab commit a8d99d2
Showing 1 changed file with 3 additions and 0 deletions.
3 changes: 3 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -136,6 +136,9 @@ If you have installed the FRC Toolchain to a directory other than the default, o

Once a PR has been submitted, formatting can be run in CI by commenting `/format` on the PR. A new commit will be pushed with the formatting changes.

> [!NOTE]
> The `/format` action has been temporarily disabled. The individual formatting commands can be run locally as shown below. Alternately, the Lint and Format action for a PR will upload a patch file that can be downloaded and applied manually.
#### wpiformat

wpiformat can be executed anywhere in the repository via `py -3 -m wpiformat` on Windows or `python3 -m wpiformat` on other platforms.
Expand Down

0 comments on commit a8d99d2

Please sign in to comment.