Specify the minimum click version (#284)

[etc/vim.git] / README.md

diff --git a/README.md b/README.md
index 41ad465359e3ecb3c6c0d866eac1e433f2ca2b95..f0a6babe2fbb7d13349b329c0bb8abe5efe20251 100644 (file)
--- a/README.md
+++ b/README.md
@@ -80,13 +80,15 @@ 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
                               files.  This will put trailing commas in function
                               signatures and calls also after *args and
                               **kwargs.  [default: per-file auto-detection]
+  -S, --skip-string-normalization
+                              Don't normalize string quotes or prefixes.
   --version                   Show the version and exit.
   --help                      Show this message and exit.
 ```
@@ -275,9 +277,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
@@ -338,6 +348,12 @@ 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.
 
+If you are adopting *Black* in a large project with pre-existing string
+conventions (like the popular ["single quotes for data, double quotes for
+human-readable strings"](https://stackoverflow.com/a/56190)), you can
+pass `--skip-string-normalization` on the command line.  This is meant as
+an adoption helper, avoid using this for new projects.
+
 
 ### Line breaks & binary operators
 
@@ -498,7 +514,7 @@ $ where black
     - Arguments: $FilePath$
 
 5. Format the currently opened file by selecting `Tools -> External Tools -> black`.
-    - Alternatively, you can set a keyboard shortcut by navigating to `Preferences -> Keymap`.
+    - Alternatively, you can set a keyboard shortcut by navigating to `Preferences -> Keymap -> External Tools -> External Tools - Black`.
 
 
 ### Vim
@@ -680,7 +696,12 @@ More details can be found in [CONTRIBUTING](CONTRIBUTING.md).
 
 ## Change Log
 
-### 18.5b1 (unreleased)
+### 18.6b0
+
+* added `--skip-string-normalization` (#118)
+
+
+### 18.5b1
 
 * added `--pyi` (#249)
 
@@ -689,6 +710,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)
 
@@ -701,6 +725,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
 
@@ -959,6 +989,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)