diff options
author | Kevin Van Brunt <kmvanbrunt@gmail.com> | 2020-02-13 16:43:23 -0500 |
---|---|---|
committer | Kevin Van Brunt <kmvanbrunt@gmail.com> | 2020-02-13 16:43:23 -0500 |
commit | 19312f442be58590f4373e2455c4ee14e3397174 (patch) | |
tree | 278648bf0aba9ab05792718566bb00019d17c5bc /examples | |
parent | 8cfc02d4fe7f33549ce190aec30535800651e705 (diff) | |
download | cmd2-git-19312f442be58590f4373e2455c4ee14e3397174.tar.gz |
Updated documentation
Diffstat (limited to 'examples')
-rwxr-xr-x | examples/basic_completion.py | 10 |
1 files changed, 5 insertions, 5 deletions
diff --git a/examples/basic_completion.py b/examples/basic_completion.py index f21f75fc..615f949d 100755 --- a/examples/basic_completion.py +++ b/examples/basic_completion.py @@ -3,14 +3,14 @@ """ A simple example demonstrating how to enable tab completion by assigning a completer function to do_* commands. This also demonstrates capabilities of the following completer methods included with cmd2: -- flag_based_complete -- index_based_complete - delimiter_completer +- flag_based_complete (see note below) +- index_based_complete (see note below) -For an example integrating tab completion with argparse, see argparse_completion.py +flag_based_complete() and index_based_complete() are basic methods and should only be used if you are not +familiar with argparse. The recommended approach for tab completing positional tokens and flags is to use +argparse-based completion. For an example integrating tab completion with argparse, see argparse_completion.py """ -import functools - import cmd2 # List of strings used with completion functions |