Skip to content

Commit

Permalink
Link isort profile to Black code style isort mention (#2246)
Browse files Browse the repository at this point in the history
The isort configuration currently in the Black code style document is
duplicated in Using Black with other tools document. I think it would
be better to consolidate information and simply link to the tool guide,
mentioning the easy profile in the original document.

I changed the link from isort PyPI page to Black's docs on isort
because for users it could be better to see the Black docs on why that
configuration is necessary and what isort is from Black's perspective.
  • Loading branch information
felix-hilden committed May 19, 2021
1 parent 7190d4f commit 3bba808
Showing 1 changed file with 3 additions and 23 deletions.
26 changes: 3 additions & 23 deletions docs/the_black_code_style/current_style.md
Expand Up @@ -128,29 +128,9 @@ indentation level (like the arguments list and the docstring in the example abov
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/) with
the following configuration.

<details>
<summary>A compatible `.isort.cfg`</summary>

```cfg
[settings]
multi_line_output = 3
include_trailing_comma = True
force_grid_wrap = 0
use_parentheses = True
ensure_newline_before_comments = True
line_length = 88
```

The equivalent command line is:

```
$ isort --multi-line=3 --trailing-comma --force-grid-wrap=0 --use-parentheses --line-width=88 [ file.py ]
```

</details>
entry. This also makes _Black_ compatible with
[isort](../guides/using_black_with_other_tools.md#isort) with the ready-made `black`
profile or manual configuration.

### Line length

Expand Down

0 comments on commit 3bba808

Please sign in to comment.