ruff, ruff-{check,format}: add page (#12377)

* ruff-format: add page

* ruff-check: add page

* ruff: add page

---------

Co-authored-by: Juri Dispan <juri.dispan@posteo.net>
This commit is contained in:
Lena
2024-02-27 15:13:53 +01:00
committed by GitHub
parent 8a05239fce
commit 6871fd11e9
3 changed files with 62 additions and 0 deletions

View File

@@ -0,0 +1,17 @@
# ruff format
> An extremely fast Python code formatter.
> If no files or directories are specified, the current working directory is used by default.
> More information: <https://docs.astral.sh/ruff/formatter>.
- Format given files or directories in-place:
`ruff format {{path/to/file_or_directory1 path/to/file_or_directory2 ...}}`
- Print which files would have been modified and return a non-zero exit code if there are files to reformat, and zero otherwise:
`ruff format --check`
- Print what changes would be made without modifying the files:
`ruff format --diff`