From: Jason Friedland <jason@friedland.id.au>
Date: Tue, 29 May 2018 06:06:02 +0000 (+1000)
Subject: Add isort args to README (#268)
X-Git-Url: https://git.madduck.net/etc/vim.git/commitdiff_plain/d320e283aa6698ea7f7b80e2ff6f58a864fcfe0f?ds=sidebyside

Add isort args to README (#268)
---

diff --git a/README.md b/README.md
index a6d7de89..e5a3036f 100644
--- a/README.md
+++ b/README.md
@@ -204,10 +204,20 @@ 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/).
 
+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:
+```
+multi_line_output=3
+include_trailing_comma=True
+force_grid_wrap=0
+line_length=88
+```
 
 ### Line length