X-Git-Url: https://git.madduck.net/etc/vim.git/blobdiff_plain/4dfec562ed3332212cb938d6d4da9671b503ac93..a20a3eeb0f738d3434efe3be8932db11722757a4:/README.md diff --git a/README.md b/README.md index 4e3ad33..a898efa 100644 --- a/README.md +++ b/README.md @@ -53,11 +53,13 @@ black [OPTIONS] [SRC]... Options: -l, --line-length INTEGER Where to wrap around. [default: 88] - --check Don't write back the files, just return the + --check Don't write the files back, just return the 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. + --diff Don't write the files back, just output a diff + for each file on stdout. --fast / --safe If --fast given, skip temporary sanity checks. [default: --safe] --version Show the version and exit. @@ -159,7 +161,7 @@ def very_important_function( debug: bool = False, ): """Applies `variables` to the `template` and writes to `file`.""" - with open(file, 'w') as f: + with open(file, "w") as f: ... ``` @@ -260,6 +262,15 @@ if you'd like a trailing comma in this situation and *Black* didn't recognize it was safe to do so, put it there manually and *Black* will keep it. +### Strings + +*Black* prefers double quotes (`"` and `"""`), but only if this does not +result in more escaping. It will remove escape sequences as necessary as +part of moving to the other type of quote. This applies to all kinds of +prefixed strings, including *raw-strings* (`r""`), *byte literals* (`b""`), +and *formatted strings* (`f""`). The approach above strikes a good balance +between consistency and legibility. + ## Editor integration @@ -385,6 +396,11 @@ More details can be found in [CONTRIBUTING](CONTRIBUTING.md). ### 18.3a5 (unreleased) +* added `--diff` (#87) + +* add line breaks before all delimiters, except in cases like commas, to better + comply with PEP 8 (#73) + * fixed handling of standalone comments within nested bracketed expressions; Black will no longer produce super long lines or put all standalone comments at the end of the expression (#22) @@ -504,5 +520,5 @@ Multiple contributions by: * [Daniel M. Capella](mailto:polycitizen@gmail.com) * [Eli Treuherz](mailto:eli.treuherz@cgi.com) * Hugo van Kemenade -* [Mika⠙](mailto:mail@autophagy.io) +* [Mika Naylor](mailto:mail@autophagy.io) * [Osaetin Daniel](mailto:osaetindaniel@gmail.com)