X-Git-Url: https://git.madduck.net/etc/vim.git/blobdiff_plain/e74117f172e29e8a980e2c9de929ad50d3769150..fb84d8b2ee524a9b3bff51fa35054abb44740f1d:/README.md diff --git a/README.md b/README.md index d1724ca..5a6825f 100644 --- a/README.md +++ b/README.md @@ -43,6 +43,11 @@ 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. --fast / --safe If --fast given, skip temporary sanity checks. [default: --safe] --version Show the version and exit. @@ -69,7 +74,7 @@ makes `pycodestyle` happy. As for vertical whitespace, *Black* tries to render one full expression or simple statement per line. If this fits the allotted line length, great. -```!py3 +```py3 # in: l = [1, 2, @@ -82,7 +87,7 @@ l = [1, 2, 3] If not, *Black* will look at the contents of the first outer matching brackets and put that in a separate indented line. -```!py3 +```py3 # in: l = [[n for n in list_bosses()], [n for n in list_employees()]] @@ -99,7 +104,7 @@ comma-separated (like an argument list, or a dict literal, and so on) then *Black* will first try to keep them on the same line with the matching brackets. If that doesn't work, it will put all of them in separate lines. -```!py3 +```py3 # in: def very_important_function(template: str, *variables, *, file: os.PathLike, debug: bool = False): """Applies `variables` to the `template` and writes to `file`.""" @@ -165,7 +170,7 @@ If you're using Flake8, you can bump `max-line-length` to 88 and forget about it. Alternatively, use [Bugbear](https://github.com/PyCQA/flake8-bugbear)'s B950 warning instead of E501 and keep the max line length at 80 which you are probably already using. You'd do it like this: -```!ini +```ini [flake8] max-line-length = 80 ... @@ -203,6 +208,11 @@ developer of Twisted and CPython: > At least the name is good. +**Kenneth Reitz**, creator of [`requests`](http://python-requests.org/) +and [`pipenv`](https://docs.pipenv.org/): + +> This vastly improves the formatting of our code. Thanks a ton! + ## Tests @@ -221,7 +231,7 @@ statements. 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 -releases (check out [pathlib](docs.python.org/3/library/pathlib.html) or +releases (check out [pathlib](https://docs.python.org/3/library/pathlib.html) or f-strings) instead of wasting cycles on Unicode compatibility, and so on. @@ -246,13 +256,36 @@ You can still try but prepare to be disappointed. ## Change Log +### 18.3a1 + +* added `--check` + +* only put trailing commas in function signatures and calls if it's + safe to do so. If the file is Python 3.6+ it's always safe, otherwise + only safe if there are no `*args` or `**kwargs` used in the signature + or call. (#8) + +* fixed invalid spacing of dots in relative imports (#6, #13) + +* fixed invalid splitting after comma on unpacked variables in for-loops + (#23) + +* fixed spurious space in parenthesized set expressions (#7) + +* fixed spurious space after opening parentheses and in default + arguments (#14, #17) + +* fixed spurious space after unary operators when the operand was + a complex expression (#15) + + ### 18.3a0 * first published version, Happy 🍰 Day 2018! * alpha quality -* date-versioned (see: http://calver.org/) +* date-versioned (see: https://calver.org/) ## Authors