From 80cc94e3de50f5dbbf0352890f832aa6dd41fa36 Mon Sep 17 00:00:00 2001 From: Timothy Crosley Date: Sat, 5 Sep 2020 04:34:31 -0700 Subject: [PATCH] Fixed #1463: Better interactive documentation for future option. --- CHANGELOG.md | 3 +++ isort/main.py | 7 ++++++- 2 files changed, 9 insertions(+), 1 deletion(-) diff --git a/CHANGELOG.md b/CHANGELOG.md index 3c504a2fb..2bb54d3cb 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -4,6 +4,9 @@ Changelog NOTE: isort follows the [semver](https://semver.org/) versioning standard. Find out more about isort's release policy [here](https://pycqa.github.io/isort/docs/major_releases/release_policy/). +### 5.6.0 TBD + - Fixed #1463: Better interactive documentation for future option. + ### 5.5.1 September 4, 2020 - Fixed #1454: Ensure indented import sections with import heading and a preceding comment don't cause import sorting loops. - Fixed #1453: isort error when float to top on almost empty file. diff --git a/isort/main.py b/isort/main.py index e7dc61ad5..3d9283173 100644 --- a/isort/main.py +++ b/isort/main.py @@ -267,7 +267,12 @@ def _build_arg_parser() -> argparse.ArgumentParser: "--future", dest="known_future_library", action="append", - help="Force isort to recognize a module as part of the future compatibility libraries.", + help="Force isort to recognize a module as part of Python's internal future compatibility " + "libraries. WARNING: this overrides the behavior of __future__ handling and therefore" + " can result in code that can't execute. If you're looking to add dependencies such " + "as six a better option is to create a another section below --future using custom " + "sections. See: https://github.com/PyCQA/isort#custom-sections-and-ordering and the " + "discussion here: https://github.com/PyCQA/isort/issues/1463.", ) parser.add_argument( "--fas",