]> git.madduck.net Git - etc/vim.git/commitdiff

madduck's git repository

Every one of the projects in this repository is available at the canonical URL git://git.madduck.net/madduck/pub/<projectpath> — see each project's metadata for the exact URL.

All patches and comments are welcome. Please squash your changes to logical commits before using git-format-patch and git-send-email to patches@git.madduck.net. If you'd read over the Git project's submission guidelines and adhered to them, I'd be especially grateful.

SSH access, as well as push access can be individually arranged.

If you use my repositories frequently, consider adding the following snippet to ~/.gitconfig and using the third clone URL listed for each project:

[url "git://git.madduck.net/madduck/"]
  insteadOf = madduck:

Reword --pyi and --py36 documentation
authorŁukasz Langa <lukasz@langa.pl>
Wed, 23 May 2018 18:52:41 +0000 (11:52 -0700)
committerŁukasz Langa <lukasz@langa.pl>
Wed, 23 May 2018 18:52:41 +0000 (11:52 -0700)
README.md
black.py

index 77b077c29b5bfcd3f10db1dec47dcd0276303fb8..8212e42247abed77767c1b0d6dfce0836fc0fecd 100644 (file)
--- a/README.md
+++ b/README.md
@@ -80,6 +80,13 @@ Options:
   -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]
   --version                   Show the version and exit.
   --help                      Show this message and exit.
 ```
@@ -653,10 +660,9 @@ More details can be found in [CONTRIBUTING](CONTRIBUTING.md).
 
 ### 18.5b1 (unreleased)
 
-* Added `--pyi` option to force pyi-style formatting (regardless of file
-  extension, or when piping source to *Black*), and `--py36` option to force
-  allowing Py36 syntax (e.g. trailing commas after `*args` or `**kwargs`), even
-  if the file doesn't currently use any 3.6-only syntax (#249)
+* added `--pyi` (#249)
+
+* added `--py36` (#249)
 
 * Python grammar pickle caches are stored with the formatting caches, making
   *Black* work in environments where site-packages is not user-writable (#192)
@@ -673,6 +679,7 @@ More details can be found in [CONTRIBUTING](CONTRIBUTING.md).
   a trailer that was omitted from line splitting on a large expression
   (#238)
 
+
 ### 18.5b0
 
 * call chains are now formatted according to the
index 0aba2c5de0fd6f20b48f17aa057f0bbac3c0d22f..a31aa7ac4402812d3c54e98125b7e8e3e2a6feb6 100644 (file)
--- a/black.py
+++ b/black.py
@@ -162,14 +162,18 @@ class Changed(Enum):
 @click.option(
     "--pyi",
     is_flag=True,
-    help="Force pyi (stub file) formatting, regardless of file extension.",
+    help=(
+        "Consider all input files typing stubs regardless of file extension "
+        "(useful when piping source on standard input)."
+    ),
 )
 @click.option(
     "--py36",
     is_flag=True,
     help=(
-        "Force Python 3.6 mode, even if file doesn't currently use "
-        "Python 3.6-only syntax."
+        "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]"
     ),
 )
 @click.version_option(version=__version__)