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

Reword --pyi and --py36 documentation

Browse Source
This commit is contained in:
Łukasz Langa 2018-05-23 11:52:41 -07:00
parent 230f1d277c
commit bbed104e6d
2 changed files with 18 additions and 7 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

15
README.md
View File

@ -80,6 +80,13 @@ Options:
-q, --quiet Don't emit non-error messages to stderr. Errors -q, --quiet Don't emit non-error messages to stderr. Errors
are still emitted, silence those with are still emitted, silence those with
2>/dev/null. 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. --version Show the version and exit.
--help Show this message and exit. --help Show this message and exit.
``` ```
@ -653,10 +660,9 @@ More details can be found in [CONTRIBUTING](CONTRIBUTING.md).
### 18.5b1 (unreleased) ### 18.5b1 (unreleased)
* Added `--pyi` option to force pyi-style formatting (regardless of file * added `--pyi` (#249)
extension, or when piping source to *Black*), and `--py36` option to force
allowing Py36 syntax (e.g. trailing commas after `*args` or `**kwargs`), even * added `--py36` (#249)
if the file doesn't currently use any 3.6-only syntax (#249)
* Python grammar pickle caches are stored with the formatting caches, making * Python grammar pickle caches are stored with the formatting caches, making
*Black* work in environments where site-packages is not user-writable (#192) *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 a trailer that was omitted from line splitting on a large expression
(#238) (#238)
### 18.5b0 ### 18.5b0
* call chains are now formatted according to the * call chains are now formatted according to the

10
black.py
View File

@ -162,14 +162,18 @@ class Changed(Enum):
@click.option( @click.option(
"--pyi", "--pyi",
is_flag=True, 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( @click.option(
"--py36", "--py36",
is_flag=True, is_flag=True,
help=( help=(
"Force Python 3.6 mode, even if file doesn't currently use " "Allow using Python 3.6-only syntax on all input files. This will put "
"Python 3.6-only syntax." "trailing commas in function signatures and calls also after *args and "
"**kwargs. [default: per-file auto-detection]"
), ),
) )
@click.version_option(version=__version__) @click.version_option(version=__version__)