X-Git-Url: https://git.madduck.net/etc/vim.git/blobdiff_plain/79b720ca9fef431ba03d28be3c37b67ed28aec71..cf6f577928f5a1f4e98b02b8e723311cae830305:/README.md diff --git a/README.md b/README.md index 20ab4be..014780b 100644 --- a/README.md +++ b/README.md @@ -1,6 +1,6 @@ # black -[![Build Status](https://travis-ci.org/ambv/black.svg?branch=master)](https://travis-ci.org/ambv/black) +[![Build Status](https://travis-ci.org/ambv/black.svg?branch=master)](https://travis-ci.org/ambv/black) ![License: MIT](https://img.shields.io/github/license/ambv/black.svg) ![PyPI](https://img.shields.io/pypi/v/black.svg) [![Code style: black](https://img.shields.io/badge/code%20style-black-000000.svg)](https://github.com/ambv/black) > Any color you like. @@ -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* @@ -249,6 +251,18 @@ and [`pipenv`](https://docs.pipenv.org/): > This vastly improves the formatting of our code. Thanks a ton! +## Show your style + +Use the badge in your project's README.md: + +```markdown +[![Code style: black](https://img.shields.io/badge/code%20style-black-000000.svg)](https://github.com/ambv/black) +``` + +Looks like this: [![Code style: black](https://img.shields.io/badge/code%20style-black-000000.svg)](https://github.com/ambv/black) + + + ## Tests Just run: @@ -261,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 @@ -293,6 +306,25 @@ More details can be found in [CONTRIBUTING](CONTRIBUTING.md). ## Change Log +### 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) + +* don't omit whitespace if the previous factor leaf wasn't a math + operator (#55) + +* omit extra space in kwarg unpacking if it's the first argument (#46) + + ### 18.3a3 * don't remove single empty lines outside of bracketed expressions