summaryrefslogtreecommitdiff
path: root/python/argcomplete/README
diff options
context:
space:
mode:
Diffstat (limited to 'python/argcomplete/README')
-rw-r--r--python/argcomplete/README5
1 files changed, 5 insertions, 0 deletions
diff --git a/python/argcomplete/README b/python/argcomplete/README
index 5696927122..d4c36cf332 100644
--- a/python/argcomplete/README
+++ b/python/argcomplete/README
@@ -5,5 +5,10 @@ Tab complete all the things!
Argcomplete provides easy, extensible command line tab completion of arguments
for your Python script.
+Argcomplete is particularly useful if your program has lots of options
+or subparsers, and if your program can dynamically suggest completions
+for your argument/option values.
+
+Note:
You need to run activate-global-python-argcomplete script once you install
this package