Fix dangling file in documentation

[etc/vim.git] / README.md

diff --git a/README.md b/README.md
index 77b077c29b5bfcd3f10db1dec47dcd0276303fb8..41ad465359e3ecb3c6c0d866eac1e433f2ca2b95 100644 (file)
--- a/README.md
+++ b/README.md
@@ -80,6 +80,13 @@ 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
+                              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]
   --version                   Show the version and exit.
   --help                      Show this message and exit.
 ```
@@ -197,10 +204,26 @@ 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/).  Use
-`multi_line_output=3`, `include_trailing_comma=True`,
-`force_grid_wrap=0`, and `line_length=88` in your isort config.
+makes *Black* compatible with [isort](https://pypi.org/p/isort/) with
+the following configuration.
 
+<details>
+<summary>A compatible `.isort.cfg`</summary>
+
+```
+[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
 
@@ -521,6 +544,12 @@ 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.
 
+To run *Black* on save, add the following line to `.vimrc` or `init.vim`:
+
+```
+autocmd BufWritePost *.py execute ':Black'
+```
+
 **How to get Vim with Python 3.6?**
 On Ubuntu 17.10 Vim comes with Python 3.6 by default.
 On macOS with Homebrew run: `brew install vim --with-python3`.
@@ -653,10 +682,9 @@ More details can be found in [CONTRIBUTING](CONTRIBUTING.md).
 
 ### 18.5b1 (unreleased)
 
-* Added `--pyi` option to force pyi-style formatting (regardless of file
-  extension, or when piping source to *Black*), and `--py36` option to force
-  allowing Py36 syntax (e.g. trailing commas after `*args` or `**kwargs`), even
-  if the file doesn't currently use any 3.6-only syntax (#249)
+* added `--pyi` (#249)
+
+* added `--py36` (#249)
 
 * Python grammar pickle caches are stored with the formatting caches, making
   *Black* work in environments where site-packages is not user-writable (#192)
@@ -673,6 +701,7 @@ More details can be found in [CONTRIBUTING](CONTRIBUTING.md).
   a trailer that was omitted from line splitting on a large expression
   (#238)
 
+
 ### 18.5b0
 
 * call chains are now formatted according to the