From 537ea8df35b1004bdb228b483907fb5dd92e5257 Mon Sep 17 00:00:00 2001
From: Maximilian Cosmo Sitter <48606431+mcsitter@users.noreply.github.com>
Date: Wed, 22 Jul 2020 02:29:38 +0200
Subject: [PATCH] Update to accomodate isort 5 release changes. (#1559)

Isort 5 introduced profiles and ensure_newline_before_comments options. Either needs to be added to work correctly with black.

Co-authored-by: Richard Si <63936253+ichard26@users.noreply.github.com>
---
 docs/compatible_configs.md   | 15 ++++++++++++++-
 docs/the_black_code_style.md | 13 +++++++------
 2 files changed, 21 insertions(+), 7 deletions(-)

diff --git a/docs/compatible_configs.md b/docs/compatible_configs.md
index aa7cd96..723fc88 100644
--- a/docs/compatible_configs.md
+++ b/docs/compatible_configs.md
@@ -23,6 +23,7 @@ multi_line_output = 3
 include_trailing_comma = True
 force_grid_wrap = 0
 use_parentheses = True
+ensure_newline_before_comments = True
 line_length = 88
 ```
 
@@ -62,7 +63,15 @@ The option `force_grid_wrap = 0` is just to tell isort to only wrap imports that
 the `line_length` limit.
 
 Finally, isort should be told to wrap imports when they surpass _Black_'s default limit
-of 88 characters via `line_length = 88`.
+of 88 characters via `line_length = 88` as well as
+`ensure_newline_before_comments = True` to ensure spacing import sections with comments
+works the same as with _Black_.
+
+**Please note** `ensure_newline_before_comments = True` only works since isort >= 5 but
+does not break older versions so you can keep it if you are running previous versions.
+If only isort >= 5 is used you can add `profile = black` instead of all the options
+since [profiles](https://timothycrosley.github.io/isort/docs/configuration/profiles/)
+are available and do the configuring for you.
 
 ### Formats
 
@@ -75,6 +84,7 @@ multi_line_output = 3
 include_trailing_comma = True
 force_grid_wrap = 0
 use_parentheses = True
+ensure_newline_before_comments = True
 line_length = 88
 ```
 
@@ -89,6 +99,7 @@ multi_line_output = 3
 include_trailing_comma = True
 force_grid_wrap = 0
 use_parentheses = True
+ensure_newline_before_comments = True
 line_length = 88
 ```
 
@@ -103,6 +114,7 @@ multi_line_output = 3
 include_trailing_comma = true
 force_grid_wrap = 0
 use_parentheses = true
+ensure_newline_before_comments = true
 line_length = 88
 ```
 
@@ -117,6 +129,7 @@ multi_line_output = 3
 include_trailing_comma = True
 force_grid_wrap = 0
 use_parentheses = True
+ensure_newline_before_comments = True
 line_length = 88
 ```
 
diff --git a/docs/the_black_code_style.md b/docs/the_black_code_style.md
index 21f217d..09d5830 100644
--- a/docs/the_black_code_style.md
+++ b/docs/the_black_code_style.md
@@ -153,13 +153,14 @@ 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
-line_length=88
+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:
-- 
2.39.5