Document formatter progress scripts (#6035)

## Summary

Add documentation to the formatter progress scripts

## Test Plan

n/a
This commit is contained in:
konsti 2023-07-24 19:42:20 +02:00 committed by GitHub
parent fdb3c8852f
commit a9f535997d
No known key found for this signature in database
GPG key ID: 4AEE18F83AFDEB23
2 changed files with 18 additions and 3 deletions

View file

@ -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