From bbed104e6d3e89ebb8da7c209b842e8a96bcd5de Mon Sep 17 00:00:00 2001 From: =?utf8?q?=C5=81ukasz=20Langa?= Date: Wed, 23 May 2018 11:52:41 -0700 Subject: [PATCH] Reword --pyi and --py36 documentation --- README.md | 15 +++++++++++---- black.py | 10 +++++++--- 2 files changed, 18 insertions(+), 7 deletions(-) diff --git a/README.md b/README.md index 77b077c..8212e42 100644 --- 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 diff --git a/black.py b/black.py index 0aba2c5..a31aa7a 100644 --- 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__) -- 2.39.5