X-Git-Url: https://git.madduck.net/etc/vim.git/blobdiff_plain/584d51a042e7ae437491d5f4cecee73fba14ab37..8c565d86843649dc1467b5909b446021e4417bba:/README.md?ds=sidebyside diff --git a/README.md b/README.md index 6ec8dd8..5d3b118 100644 --- a/README.md +++ b/README.md @@ -44,10 +44,10 @@ black [OPTIONS] [SRC]... Options: -l, --line-length INTEGER Where to wrap around. [default: 88] --check Don't write back the files, just return the - status. Return code 0 means nothing changed. - Return code 1 means some files were reformatted. - Return code 123 means there was an internal - error. + status. Return code 0 means nothing would + change. Return code 1 means some files would be + reformatted. Return code 123 means there was an + internal error. --fast / --safe If --fast given, skip temporary sanity checks. [default: --safe] --version Show the version and exit. @@ -58,7 +58,9 @@ Options: * it does nothing if no sources are passed to it; * it will read from standard input and write to standard output if `-` is used as the filename; -* it only outputs messages to users on standard error. +* it only outputs messages to users on standard error; +* exits with code 0 unless an internal error occured (or `--check` was + used). ## The philosophy behind *Black* @@ -273,8 +275,7 @@ python setup.py test But you can reformat Python 2 code with it, too. *Black* is able to parse all of the new syntax supported on Python 3.6 but also *effectively all* -the Python 2 syntax at the same time, as long as you're not using print -statements. +the Python 2 syntax at the same time. By making the code exclusively Python 3.6+, I'm able to focus on the quality of the formatting and re-use all the nice features of the new @@ -307,6 +308,14 @@ More details can be found in [CONTRIBUTING](CONTRIBUTING.md). ### 18.3a4 (unreleased) +* automatic detection of deprecated Python 2 forms of print statements + and exec statements in the formatted file (#49) + +* use proper spaces for complex expressions in default values of typed + function arguments (#60) + +* only return exit code 1 when --check is used (#50) + * don't remove single trailing commas from square bracket indexing (#59) @@ -315,6 +324,9 @@ More details can be found in [CONTRIBUTING](CONTRIBUTING.md). * omit extra space in kwarg unpacking if it's the first argument (#46) +* omit extra space in [Sphinx auto-attribute comments](http://www.sphinx-doc.org/en/stable/ext/autodoc.html#directive-autoattribute) + (#68) + ### 18.3a3