Handle Docstrings as bytes + strip all whitespace (#2037)

[etc/vim.git] / docs / compatible_configs.md

diff --git a/docs/compatible_configs.md b/docs/compatible_configs.md
index 82f13932b0b22676de72ff9ad9e86408ea6aff32..a4f83ee472fe25424b3134000ad246d3770edf62 100644 (file)
--- a/docs/compatible_configs.md
+++ b/docs/compatible_configs.md
@@ -10,6 +10,9 @@ tools out there.
 (e.g. `pyproject.toml`). The provided examples are to only configure their corresponding
 tools, using **their** supported file formats.
 
+Compatible configuration files can be
+[found here](https://github.com/psf/black/blob/master/docs/compatible_configs/).
+
 ## isort
 
 [isort](https://pypi.org/p/isort/) helps to sort and format imports in your Python code.
@@ -156,6 +159,13 @@ whitespace around slice operators. Due to this, Flake8 will raise
 `E203 whitespace before ':'` warnings. Since this warning is not PEP 8 compliant, Flake8
 should be configured to ignore it via `extend-ignore = E203`.
 
+When breaking a line, _Black_ will break it before a binary operator. This is compliant
+with PEP 8 as of
+[April 2016](https://github.com/python/peps/commit/c59c4376ad233a62ca4b3a6060c81368bd21e85b#diff-64ec08cc46db7540f18f2af46037f599).
+There's a disabled-by-default warning in Flake8 which goes against this PEP 8
+recommendation called `W503 line break before binary operator`. It should not be enabled
+in your configuration.
+
 Also, as like with isort, flake8 should be configured to allow lines up to the length
 limit of `88`, _Black_'s default. This explains `max-line-length = 88`.
 
@@ -211,7 +221,7 @@ max-line-length = 88
 ### Why those options above?
 
 When _Black_ is folding very long expressions, the closing brackets will
-[be dedented](https://github.com/psf/black#how-black-wraps-lines).
+[be dedented](https://github.com/psf/black/blob/master/docs/the_black_code_style.md#how-black-wraps-lines).
 
 ```py3
 ImportantClass.important_method(