Skip to content

Commit 19312f4

Browse files
committed
Updated documentation
1 parent 8cfc02d commit 19312f4

File tree

1 file changed

+5
-5
lines changed

1 file changed

+5
-5
lines changed

examples/basic_completion.py

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -3,14 +3,14 @@
33
"""
44
A simple example demonstrating how to enable tab completion by assigning a completer function to do_* commands.
55
This also demonstrates capabilities of the following completer methods included with cmd2:
6-
- flag_based_complete
7-
- index_based_complete
86
- delimiter_completer
7+
- flag_based_complete (see note below)
8+
- index_based_complete (see note below)
99
10-
For an example integrating tab completion with argparse, see argparse_completion.py
10+
flag_based_complete() and index_based_complete() are basic methods and should only be used if you are not
11+
familiar with argparse. The recommended approach for tab completing positional tokens and flags is to use
12+
argparse-based completion. For an example integrating tab completion with argparse, see argparse_completion.py
1113
"""
12-
import functools
13-
1414
import cmd2
1515

1616
# List of strings used with completion functions

0 commit comments

Comments
 (0)