Automatic management of parentheses in `elif`, too

[etc/vim.git] / README.md

diff --git a/README.md b/README.md
index bc8977b7a9acff4b8a2a1de39b7abb49f3183fb2..aca49994cd7f268ad520d41384ed0801f083763e 100644 (file)
--- a/README.md
+++ b/README.md
@@ -14,7 +14,7 @@
 
 
 *Black* is the uncompromising Python code formatter.  By using it, you
 
 
 *Black* is the uncompromising Python code formatter.  By using it, you

-agree to cease control over minutiae of hand-formatting.  In return,
+agree to cede control over minutiae of hand-formatting.  In return,

 *Black* gives you speed, determinism, and freedom from `pycodestyle`
 nagging about formatting.  You will save time and mental energy for
 more important matters.
 *Black* gives you speed, determinism, and freedom from `pycodestyle`
 nagging about formatting.  You will save time and mental energy for
 more important matters.


@@ -180,8 +180,9 @@ If a line of "from" imports cannot fit in the allotted length, it's always split
 into one per line.  Imports tend to change often and this minimizes diffs, as well
 as enables readers of code to easily find which commit introduced a particular
 import.  This exception also makes *Black* compatible with
 into one per line.  Imports tend to change often and this minimizes diffs, as well
 as enables readers of code to easily find which commit introduced a particular
 import.  This exception also makes *Black* compatible with

-[isort](https://pypi.org/p/isort/).  Use `multi_line_output=3` and
-`include_trailing_comma=True` in your isort config.
+[isort](https://pypi.org/p/isort/).  Use `multi_line_output=3`,
+`include_trailing_comma=True`, `force_grid_wrap=0`, and `line_length=88` in your
+isort config.

 
 
 ### Line length
 
 
 ### Line length


@@ -302,6 +303,19 @@ This behaviour may raise ``W503 line break before binary operator`` warnings in
 style guide enforcement tools like Flake8. Since ``W503`` is not PEP 8 compliant,
 you should tell Flake8 to ignore these warnings.
 
 style guide enforcement tools like Flake8. Since ``W503`` is not PEP 8 compliant,
 you should tell Flake8 to ignore these warnings.
 

+### Slices
+
+PEP 8 [recommends](https://www.python.org/dev/peps/pep-0008/#whitespace-in-expressions-and-statements)
+to treat ``:`` in slices as a binary operator with the lowest priority, and to
+leave an equal amount of space on either side, except if a parameter is omitted
+(e.g. ``ham[1 + 1 :]``). It also states that for extended slices, both ``:``
+operators have to have the same amount of spacing, except if a parameter is
+omitted (``ham[1 + 1 ::]``). *Black* enforces these rules consistently.
+
+This behaviour may raise ``E203 whitespace before ':'`` warnings in style guide
+enforcement tools like Flake8. Since ``E203`` is not PEP 8 compliant, you should
+tell Flake8 to ignore these warnings.
+

 ### Parentheses
 
 Some parentheses are optional in the Python grammar.  Any expression can
 ### Parentheses
 
 Some parentheses are optional in the Python grammar.  Any expression can


@@ -313,6 +327,11 @@ interesting cases:
 - `for (...) in (...):`
 - `assert (...), (...)`
 - `from X import (...)`
 - `for (...) in (...):`
 - `assert (...), (...)`
 - `from X import (...)`

+- assignments like:
+  - `target = (...)`
+  - `target: type = (...)`
+  - `some, *un, packing = (...)`
+  - `augmented += (...)`

 
 In those cases, parentheses are removed when the entire statement fits
 in one line, or if the inner expression doesn't have any delimiters to
 
 In those cases, parentheses are removed when the entire statement fits
 in one line, or if the inner expression doesn't have any delimiters to


@@ -522,6 +541,31 @@ More details can be found in [CONTRIBUTING](CONTRIBUTING.md).
 
 ## Change Log
 
 
 ## Change Log
 

+### 18.5a0 (unreleased)
+
+* slices are now formatted according to PEP 8 (#178)
+
+* parentheses are now also managed automatically on the right-hand side
+  of assignments and return statements (#140)
+
+* math operators now use their respective priorities for delimiting multiline
+  expressions (#148)
+
+* empty parentheses in a class definition are now removed (#145, #180)
+
+* fixed an invalid trailing comma sometimes left in imports (#185)
+
+* fixed non-deterministic formatting when multiple pairs of removable parentheses
+  were used (#183)
+
+* fixed not splitting long from-imports with only a single name
+
+* fixed Python 3.6+ file discovery by also looking at function calls with
+  unpacking. This fixed non-deterministic formatting if trailing commas
+  where used both in function signatures with stars and function calls
+  with stars but the former would be reformatted to a single line.
+
+

 ### 18.4a4
 
 * don't populate the cache on `--check` (#175)
 ### 18.4a4
 
 * don't populate the cache on `--check` (#175)


@@ -714,10 +758,12 @@ Maintained with [Carol Willing](mailto:carolcode@willingconsulting.com),
 Multiple contributions by:
 * [Anthony Sottile](mailto:asottile@umich.edu)
 * [Artem Malyshev](mailto:proofit404@gmail.com)
 Multiple contributions by:
 * [Anthony Sottile](mailto:asottile@umich.edu)
 * [Artem Malyshev](mailto:proofit404@gmail.com)

+* [Christian Heimes](mailto:christian@python.org)

 * [Daniel M. Capella](mailto:polycitizen@gmail.com)
 * [Eli Treuherz](mailto:eli.treuherz@cgi.com)
 * Hugo van Kemenade
 * [Ivan Katanić](mailto:ivan.katanic@gmail.com)
 * [Jonas Obrist](mailto:ojiidotch@gmail.com)
 * [Osaetin Daniel](mailto:osaetindaniel@gmail.com)
 * [Daniel M. Capella](mailto:polycitizen@gmail.com)
 * [Eli Treuherz](mailto:eli.treuherz@cgi.com)
 * Hugo van Kemenade
 * [Ivan Katanić](mailto:ivan.katanic@gmail.com)
 * [Jonas Obrist](mailto:ojiidotch@gmail.com)
 * [Osaetin Daniel](mailto:osaetindaniel@gmail.com)

+* [Sunil Kapil](mailto:snlkapil@gmail.com)

 * [Vishwas B Sharma](mailto:sharma.vishwas88@gmail.com)
 * [Vishwas B Sharma](mailto:sharma.vishwas88@gmail.com)