actions/black
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity

Clarify check argument is needed for github action workflow (#3325)

Browse Source 
Co-authored-by: Richard Si <63936253+ichard26@users.noreply.github.com>
This commit is contained in:
jlplenio 2022-10-15 20:44:02 +02:00 committed by GitHub
parent f16333e78b
commit 575220f460
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
2 changed files with 5 additions and 1 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

4
docs/integrations/github_actions.md
View File

@ -44,7 +44,9 @@ extra. Installing the extra and including Jupyter Notebook files can be configur
`jupyter` (default is `false`). `jupyter` (default is `false`).
You can also configure the arguments passed to _Black_ via `options` (defaults to You can also configure the arguments passed to _Black_ via `options` (defaults to
`'--check --diff'`) and `src` (default is `'.'`) `'--check --diff'`) and `src` (default is `'.'`). Please note that the
[`--check` flag](labels/exit-code) is required so that the workflow fails if _Black_
finds files that need to be formatted.
Here's an example configuration: Here's an example configuration:

2
docs/usage_and_configuration/the_basics.md
View File

@ -76,6 +76,8 @@ _Black_ to just tell you what it _would_ do without actually rewriting the Pytho
There's two variations to this mode that are independently enabled by their respective There's two variations to this mode that are independently enabled by their respective
flags. Both variations can be enabled at once. flags. Both variations can be enabled at once.
(labels/exit-code)=
#### Exit code #### Exit code
Passing `--check` will make _Black_ exit with: Passing `--check` will make _Black_ exit with: