Note required python version for use_pyproject: true (#4503)

This commit is contained in:
Mattwmaster58 2024-10-24 21:58:24 -04:00 committed by GitHub
parent c98fc0c128
commit 53a219056d
No known key found for this signature in database
GPG Key ID: B5690EEEBB952194

View File

@ -74,9 +74,14 @@ If you want to match versions covered by Black's
version: "~= 22.0"
```
If you want to read the version from `pyproject.toml`, set `use_pyproject` to `true`:
If you want to read the version from `pyproject.toml`, set `use_pyproject` to `true`.
Note that this requires Python >= 3.11, so using the setup-python action may be
required, for example:
```yaml
- uses: actions/setup-python@v5
with:
python-version: "3.13"
- uses: psf/black@stable
with:
options: "--check --verbose"