diff options
| -rw-r--r-- | docs/configuration/options.md | 12 | ||||
| -rwxr-xr-x | scripts/build_config_option_docs.py | 8 |
2 files changed, 14 insertions, 6 deletions
diff --git a/docs/configuration/options.md b/docs/configuration/options.md index 7d5055ea..7d9a9ec1 100644 --- a/docs/configuration/options.md +++ b/docs/configuration/options.md @@ -382,7 +382,7 @@ extra_standard_library = ["my_module1", "my_module2"] ## Known Other -**No Description** +known_OTHER is how imports of custom sections are defined. OTHER is a placeholder for the custom section name. **Type:** Dict **Default:** `{}` @@ -476,7 +476,7 @@ String to place for indents defaults to " " (4 spaces). ## Comment Prefix -**No Description** +Allows customizing how isort prefixes comments that it adds or modifies on import linesGenerally ` #` (two spaces before a pound symbol) is use, though one space is also common. **Type:** String **Default:** ` #` @@ -743,7 +743,7 @@ Ensures the output doesn't save if the resulting file contains syntax errors. ## Lines Before Imports -**No Description** +The number of blank lines to place before imports. -1 for automatic determination **Type:** Int **Default:** `-1` @@ -755,7 +755,7 @@ Ensures the output doesn't save if the resulting file contains syntax errors. ## Lines After Imports -**No Description** +The number of blank lines to place after imports. -1 for automatic determination **Type:** Int **Default:** `-1` @@ -767,7 +767,7 @@ Ensures the output doesn't save if the resulting file contains syntax errors. ## Lines Between Sections -**No Description** +The number of lines to place between sections **Type:** Int **Default:** `1` @@ -776,7 +776,7 @@ Ensures the output doesn't save if the resulting file contains syntax errors. ## Lines Between Types -**No Description** +The number of lines to place between direct and from imports **Type:** Int **Default:** `0` diff --git a/scripts/build_config_option_docs.py b/scripts/build_config_option_docs.py index f20b7b77..b6ef5d27 100755 --- a/scripts/build_config_option_docs.py +++ b/scripts/build_config_option_docs.py @@ -102,6 +102,14 @@ description_mapping = { "length_sort_sections": "Sort the given sections by length", "forced_separate": "Force certain sub modules to show separately", "sections": "What sections isort should display imports for and in what order", + "known_other": "known_OTHER is how imports of custom sections are defined. " + "OTHER is a placeholder for the custom section name.", + "comment_prefix": "Allows customizing how isort prefixes comments that it adds or modifies on import lines" + "Generally ` #` (two spaces before a pound symbol) is use, though one space is also common.", + "lines_before_imports": "The number of blank lines to place before imports. -1 for automatic determination", + "lines_after_imports": "The number of blank lines to place after imports. -1 for automatic determination", + "lines_between_sections": "The number of lines to place between sections", + "lines_between_types": "The number of lines to place between direct and from imports", } example_mapping: Dict[str, Example] |