Clarify language in README

[etc/vim.git] / README.md

diff --git a/README.md b/README.md
index a9ec9eab86167fd7f4ce39cc4076bf456ec023ca..9995936446f4a1c5871bc1790b562e494fee1ab8 100644 (file)
--- a/README.md
+++ b/README.md
@@ -106,9 +106,9 @@ the same effect, as a courtesy for straddling code.
 
 *Black* ignores previous formatting and applies uniform horizontal
 and vertical whitespace to your code.  The rules for horizontal
-whitespace are pretty obvious and can be summarized as: do whatever
-makes `pycodestyle` happy.  The coding style used by *Black* can be
-viewed as a strict subset of PEP 8.
+whitespace can be summarized as: do whatever makes `pycodestyle` happy.
+The coding style used by *Black* can be viewed as a strict subset of
+PEP 8.
 
 As for vertical whitespace, *Black* tries to render one full expression
 or simple statement per line.  If this fits the allotted line length,
@@ -327,6 +327,11 @@ interesting cases:
 - `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
@@ -409,7 +414,7 @@ Python version and automatically installs *Black*. You can upgrade it later
 by calling `:BlackUpgrade` and restarting Vim.
 
 If you need to do anything special to make your virtualenv work and
-install *Black* (for example you want to run a version from master), just
+install *Black* (for example you want to run a version from master),
 create a virtualenv manually and point `g:black_virtualenv` to it.
 The plugin will use it.
 
@@ -540,6 +545,12 @@ More details can be found in [CONTRIBUTING](CONTRIBUTING.md).
 
 * 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)
@@ -549,6 +560,11 @@ More details can be found in [CONTRIBUTING](CONTRIBUTING.md).
 
 * 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