Improve docs around custom section ordering

PyCQA · Oct 22, 2020 · 3683f54 · 3683f54
1 parent 4e3a4f5
commit 3683f54
Show file tree

Hide file tree

Showing 2 changed files with 4 additions and 2 deletions.
diff --git a/README.md b/README.md
@@ -348,7 +348,7 @@ of:
 FUTURE,STDLIB,THIRDPARTY,FIRSTPARTY,LOCALFOLDER
 ```
 
-to your preference:
+to your preference (omitting a default section may cause errors):
 
 ```ini
 sections=FUTURE,STDLIB,FIRSTPARTY,THIRDPARTY,LOCALFOLDER

diff --git a/docs/configuration/options.md b/docs/configuration/options.md
@@ -108,7 +108,9 @@ Forces line endings to the specified value. If not set, values will be guessed p
 
 ## Sections
 
-**No Description**
+Specifies a custom ordering for sections. Any custom defined sections should also be
+included in this ordering. Omitting any of the default sections from this tuple may
+result in imports being incorrectly sorted or failure.
 
 **Type:** Tuple  
 **Default:** `('FUTURE', 'STDLIB', 'THIRDPARTY', 'FIRSTPARTY', 'LOCALFOLDER')`