mirror of
https://github.com/astral-sh/ruff.git
synced 2025-08-09 21:28:21 +00:00
Document formatter progress scripts (#6035)
## Summary Add documentation to the formatter progress scripts ## Test Plan n/a
This commit is contained in:
parent
fdb3c8852f
commit
a9f535997d
2 changed files with 18 additions and 3 deletions
|
@ -1,6 +1,14 @@
|
|||
#!/usr/bin/env bash
|
||||
|
||||
# The pinned revisions are the latest of this writing, update freely
|
||||
# Check black compatibility and check for formatter instabilities and other
|
||||
# errors.
|
||||
#
|
||||
# This script will first clone a diverse set of (mostly) black formatted
|
||||
# repositories with fixed revisions to target/progress_projects. Each project
|
||||
# gets formatted (without modifying the files on disk) to check how
|
||||
# similar our style is to black. It also catches common issues such as
|
||||
# unstable formatting, internal formatter errors and printing invalid syntax.
|
||||
#
|
||||
# The pinned revisions are the latest of this writing, update freely.
|
||||
|
||||
set -ex
|
||||
|
||||
|
|
Loading…
Add table
Add a link
Reference in a new issue