Move setuptools and wheel to dev deps, upgrade them, too

[etc/vim.git] / README.md

diff --git a/README.md b/README.md
index e5a3036fb7bac35fcee8eecb091be3454c9dd3ab..9a0079d3322729ae226e0b62aa8a974ae8c9b9d4 100644 (file)
--- a/README.md
+++ b/README.md
@@ -80,7 +80,7 @@ Options:
   -q, --quiet                 Don't emit non-error messages to stderr. Errors
                               are still emitted, silence those with
                               2>/dev/null.
-   --pyi                      Consider all input files typing stubs regardless
+  --pyi                       Consider all input files typing stubs regardless
                               of file extension (useful when piping source on
                               standard input).
   --py36                      Allow using Python 3.6-only syntax on all input
@@ -204,21 +204,27 @@ If a data structure literal (tuple, list, set, dict) or a line of "from"
 imports cannot fit in the allotted length, it's always split into one
 element per line.  This minimizes diffs as well as enables readers of
 code to find which commit introduced a particular entry.  This also
-makes *Black* compatible with [isort](https://pypi.org/p/isort/).
+makes *Black* compatible with [isort](https://pypi.org/p/isort/) with
+the following configuration.
+
+<details>
+<summary>A compatible `.isort.cfg`</summary>
 
-If you do wish to use *Black* alongside `isort`, you can pass the following
-command-line arguments to ensure compatible behaviour:
-```
-$ isort --multi-line=3 --trailing-comma --force-grid-wrap=0 --line-width=88 [ file.py ]
-```
-Or use the equivalent directives in your isort config:
 ```
+[settings]
 multi_line_output=3
 include_trailing_comma=True
 force_grid_wrap=0
+combine_as_imports=True
 line_length=88
 ```
 
+The equivalent command line is:
+```
+$ isort --multi-line=3 --trailing-comma --force-grid-wrap=0 --combine-as --line-width=88 [ file.py ]
+```
+</details>
+
 ### Line length
 
 You probably noticed the peculiar default line length.  *Black* defaults
@@ -269,9 +275,17 @@ are always reformatted to fit minimal space, this whitespace is lost.
 
 It will also insert proper spacing before and after function definitions.
 It's one line before and after inner functions and two lines before and
-after module-level functions.  *Black* will not put empty lines between
-function/class definitions and standalone comments that immediately precede
-the given function/class.
+after module-level functions and classes.  *Black* will not put empty
+lines between function/class definitions and standalone comments that
+immediately precede the given function/class.
+
+*Black* will enforce single empty lines between a class-level docstring
+and the first following field or method.  This conforms to
+[PEP 257](https://www.python.org/dev/peps/pep-0257/#multi-line-docstrings).
+
+*Black* won't insert empty lines after function docstrings unless that
+empty line is required due to an inner function starting immediately
+after.
 
 
 ### Trailing commas
@@ -674,7 +688,7 @@ More details can be found in [CONTRIBUTING](CONTRIBUTING.md).
 
 ## Change Log
 
-### 18.5b1 (unreleased)
+### 18.5b1
 
 * added `--pyi` (#249)
 
@@ -683,6 +697,9 @@ More details can be found in [CONTRIBUTING](CONTRIBUTING.md).
 * Python grammar pickle caches are stored with the formatting caches, making
   *Black* work in environments where site-packages is not user-writable (#192)
 
+* *Black* now enforces a PEP 257 empty line after a class-level docstring
+  (and/or fields) and the first method
+
 * fixed invalid code produced when standalone comments were present in a trailer
   that was omitted from line splitting on a large expression (#237)
 
@@ -695,6 +712,12 @@ More details can be found in [CONTRIBUTING](CONTRIBUTING.md).
   a trailer that was omitted from line splitting on a large expression
   (#238)
 
+* fixed extra empty line between a class declaration and the first
+  method if no class docstring or fields are present (#219)
+
+* fixed extra empty line between a function signature and an inner
+  function or inner class (#196)
+
 
 ### 18.5b0
 
@@ -953,6 +976,7 @@ Multiple contributions by:
 * [Ivan Katanić](mailto:ivan.katanic@gmail.com)
 * [Jelle Zijlstra](mailto:jelle.zijlstra@gmail.com)
 * [Jonas Obrist](mailto:ojiidotch@gmail.com)
+* [Luka Sterbic](mailto:luka.sterbic@gmail.com)
 * [Miguel Gaiowski](mailto:miggaiowski@gmail.com)
 * [Osaetin Daniel](mailto:osaetindaniel@gmail.com)
 * [Sunil Kapil](mailto:snlkapil@gmail.com)