Document that W503 is not compliant with PEP 8 (#114)

[etc/vim.git] / README.md

diff --git a/README.md b/README.md
index dac918eb905940c0d8027a2587d4934745203e24..68bf4f06e777cb9e918412d528e5454e136d348d 100644 (file)
--- a/README.md
+++ b/README.md
@@ -289,6 +289,17 @@ a bit easier than double quotes.  The latter requires use of the Shift
 key.  My recommendation here is to keep using whatever is faster to type
 and let *Black* handle the transformation.
 
+### Line Breaks & Binary Operators
+
+*Black* will break a line before a binary operator when splitting a block
+of code over multiple lines. This is so that *Black* is compliant with the
+recent changes in the [PEP 8](https://www.python.org/dev/peps/pep-0008/#should-a-line-break-before-or-after-a-binary-operator)
+style guide, which emphasizes that this approach improves readability.
+
+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.
+
 
 ## Editor integration
 
@@ -369,13 +380,13 @@ repos:
     hooks:
     - id: black
       args: [--line-length=88, --safe]
-      python-version: python3.6
+      python_version: python3.6
 ```
 Then run `pre-commit install` and you're ready to go.
 
 `args` in the above config is optional but shows you how you can change
 the line length if you really need to.  If you're already using Python
-3.7, switch the `python-version` accordingly. Finally, `stable` is a tag
+3.7, switch the `python_version` accordingly. Finally, `stable` is a tag
 that is pinned to the latest release on PyPI.  If you'd rather run on
 master, this is also an option.
 
@@ -438,8 +449,12 @@ More details can be found in [CONTRIBUTING](CONTRIBUTING.md).
 
 * added `--quiet` (#78)
 
+* added [pre-commit](https://pre-commit.com) integration (#103, #104)
+
 * fixed reporting on `--check` with multiple files (#101, #102)
 
+* fixed removing backslash escapes from raw strings (#100, #105)
+
 ### 18.4a0
 
 * added `--diff` (#87)
@@ -564,15 +579,16 @@ More details can be found in [CONTRIBUTING](CONTRIBUTING.md).
 
 Glued together by [Łukasz Langa](mailto:lukasz@langa.pl).
 
-Maintained with [Carol Willing](mailto:carolcode@willingconsulting.com)
-and [Carl Meyer](mailto:carl@oddbird.net).
+Maintained with [Carol Willing](mailto:carolcode@willingconsulting.com),
+[Carl Meyer](mailto:carl@oddbird.net), and
+[Mika Naylor](mailto:mail@autophagy.io).
 
 Multiple contributions by:
+* [Anthony Sottile](mailto:asottile@umich.edu)
 * [Artem Malyshev](mailto:proofit404@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)
-* [Mika Naylor](mailto:mail@autophagy.io)
 * [Osaetin Daniel](mailto:osaetindaniel@gmail.com)
 * [Zsolt Dollenstein](mailto:zsol.zsol@gmail.com)