X-Git-Url: https://git.madduck.net/etc/vim.git/blobdiff_plain/303a0b2c4d0c828ba6cd4ef6d480f1ff2b5a11c6..4b7b5ed5b8630a906e2ef3a405134131651a251e:/README.md diff --git a/README.md b/README.md index 8d6adb0..6443569 100644 --- a/README.md +++ b/README.md @@ -3,7 +3,6 @@
-
@@ -237,9 +236,11 @@ is that **until the formatter becomes stable, you should expect some formatting
change in the future**. That being said, no drastic stylistic changes are planned,
mostly responses to bug reports.
-Also, as a temporary safety measure, _Black_ will check that the reformatted code still
-produces a valid AST that is equivalent to the original. This slows it down. If you're
-feeling confident, use `--fast`.
+Also, as a safety measure which slows down processing, _Black_ will check that the
+reformatted code still produces a valid AST that is effectively equivalent to the
+original (see the
+[Pragmatism](https://github.com/psf/black/blob/master/docs/the_black_code_style.md#pragmatism)
+section for details). If you're feeling confident, use `--fast`.
## The _Black_ code style
@@ -424,15 +425,17 @@ jobs:
- uses: actions/checkout@v2
- uses: actions/setup-python@v2
- uses: psf/black@stable
- with:
- args: ". --check"
```
-### Inputs
+You may use `options` (Default is `'--check --diff'`) and `src` (Default is `'.'`) as
+follows:
-#### `black_args`
-
-**optional**: Black input arguments. Defaults to `. --check --diff`.
+```yaml
+- uses: psf/black@stable
+ with:
+ options: "--check --verbose"
+ src: "./src"
+```
## Ignoring unmodified files