Add `--verbose` and report excluded paths in it, too

[etc/vim.git] / README.md

diff --git a/README.md b/README.md
index 79b83476c1ecc7816b0bb75fac9ef935d41aec3f..b1eae742cd73b2b0efe25a0ca8f37433f7b16f74 100644 (file)
--- a/README.md
+++ b/README.md
@@ -68,6 +68,15 @@ black [OPTIONS] [SRC]...
 
 Options:
   -l, --line-length INTEGER   Where to wrap around.  [default: 88]
 
 Options:
   -l, --line-length INTEGER   Where to wrap around.  [default: 88]

+  --py36                      Allow using Python 3.6-only syntax on all input
+                              files.  This will put trailing commas in function
+                              signatures and calls also after *args and
+                              **kwargs.  [default: per-file auto-detection]
+  --pyi                       Format all input files like typing stubs
+                              regardless of file extension (useful when piping
+                              source on standard input).
+  -S, --skip-string-normalization
+                              Don't normalize string quotes or prefixes.

   --check                     Don't write the files back, just return the
                               status.  Return code 0 means nothing would
                               change.  Return code 1 means some files would be
   --check                     Don't write the files back, just return the
                               status.  Return code 0 means nothing would
                               change.  Return code 1 means some files would be


@@ -77,18 +86,6 @@ Options:
                               for each file on stdout.
   --fast / --safe             If --fast given, skip temporary sanity checks.
                               [default: --safe]
                               for each file on stdout.
   --fast / --safe             If --fast given, skip temporary sanity checks.
                               [default: --safe]

-  -q, --quiet                 Don't emit non-error messages to stderr. Errors
-                              are still emitted, silence those with
-                              2>/dev/null.
-  --pyi                       Consider all input files typing stubs regardless
-                              of file extension (useful when piping source on
-                              standard input).
-  --py36                      Allow using Python 3.6-only syntax on all input
-                              files.  This will put trailing commas in function
-                              signatures and calls also after *args and
-                              **kwargs.  [default: per-file auto-detection]
-  -S, --skip-string-normalization
-                              Don't normalize string quotes or prefixes.

   --include TEXT              A regular expression that matches files and
                               directories that should be included on
                               recursive searches. On Windows, use forward
   --include TEXT              A regular expression that matches files and
                               directories that should be included on
                               recursive searches. On Windows, use forward


@@ -99,7 +96,12 @@ Options:
                               slashes for directories.  [default:
                               build/|buck-out/|dist/|_build/|\.git/|\.hg/|
                               \.mypy_cache/|\.tox/|\.venv/]
                               slashes for directories.  [default:
                               build/|buck-out/|dist/|_build/|\.git/|\.hg/|
                               \.mypy_cache/|\.tox/|\.venv/]

-
+  -q, --quiet                 Don't emit non-error messages to stderr. Errors
+                              are still emitted, silence those with
+                              2>/dev/null.
+  -v, --verbose               Also emit messages to stderr about files
+                              that were not changed or were ignored due to
+                              --exclude=.

   --version                   Show the version and exit.
   --help                      Show this message and exit.
 ```
   --version                   Show the version and exit.
   --help                      Show this message and exit.
 ```


@@ -628,13 +630,13 @@ repos:
     hooks:
     - id: black
       args: [--line-length=88, --safe]
     hooks:
     - id: black
       args: [--line-length=88, --safe]

-      python_version: python3.6
+      language_version: python3.6

 ```
 Then run `pre-commit install` and you're ready to go.
 
 `args` in the above config is optional but shows you how you can change
 the line length if you really need to.  If you're already using Python
 ```
 Then run `pre-commit install` and you're ready to go.
 
 `args` in the above config is optional but shows you how you can change
 the line length if you really need to.  If you're already using Python

-3.7, switch the `python_version` accordingly. Finally, `stable` is a tag
+3.7, switch the `language_version` accordingly. Finally, `stable` is a tag

 that is pinned to the latest release on PyPI.  If you'd rather run on
 master, this is also an option.
 
 that is pinned to the latest release on PyPI.  If you'd rather run on
 master, this is also an option.
 


@@ -713,6 +715,8 @@ More details can be found in [CONTRIBUTING](CONTRIBUTING.md).
 
 * added `--skip-string-normalization` (#118)
 
 
 * added `--skip-string-normalization` (#118)
 

+* added `--verbose` (#283)
+

 * fixed stdin handling not working correctly if an old version of Click was
   used (#276)
 
 * fixed stdin handling not working correctly if an old version of Click was
   used (#276)