docs: Explain that the default behaviour is ruff check (#142)

This tripped me up, I use ruff for both checking & formatting and
expected it to do both by default.
This commit is contained in:
robertHowlett
2025-05-19 11:36:40 +01:00
committed by GitHub
parent 94b3590e87
commit 257550e917
+2 -2
View File
@@ -4,8 +4,8 @@ A GitHub Action to run [ruff](https://github.com/astral-sh/ruff).
This action is commonly used as a pass/fail test to ensure your repository stays
clean, abiding the [rules](https://docs.astral.sh/ruff/rules/) specified in your
configuration. Though it runs `ruff`, the action can do anything `ruff` can (ex,
fix).
configuration. Though it runs `ruff check` by default, the action can do
anything `ruff` can (ex, fix).
## Contents