Skip to content

Commit aac03fb

Browse files
committed
Clarified role of ACArgumentParser and removed redundant description of basic_complete
1 parent bb6cc1d commit aac03fb

File tree

1 file changed

+5
-3
lines changed

1 file changed

+5
-3
lines changed

README.md

Lines changed: 5 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -147,6 +147,9 @@ Instructions for implementing each feature follow.
147147

148148
See https://cmd2.readthedocs.io/en/latest/argument_processing.html for more details
149149

150+
NOTE: `cmd2` also provides the `ACArgumentParser` customization of `argparse.ArgumentParser` for prettier formatting
151+
of help and RangeAction type
152+
150153
- `cmd2` applications function like a full-featured shell in many ways (and are cross-platform)
151154
- Run arbitrary shell commands by preceding them with `!` or `shell`
152155
- Redirect the output of any command to a file with `>` for overwrite or `>>` for append
@@ -165,7 +168,6 @@ Instructions for implementing each feature follow.
165168
- And also provide help hints for values associated with these flags
166169
- Experiment with the [argprint.py](https://github.com/python-cmd2/cmd2/blob/master/examples/arg_print.py) example
167170
using the **oprint** and **pprint** commands to get a feel for how this works
168-
- `basic_complete` helper method for tab completion against a list
169171
- `path_complete` helper method provides flexible tab-completion of file system paths
170172
- See the [paged_output.py](https://github.com/python-cmd2/cmd2/blob/master/examples/paged_output.py) example for a simple use case
171173
- See the [python_scripting.py](https://github.com/python-cmd2/cmd2/blob/master/examples/python_scripting.py) example for a more full-featured use case
@@ -176,10 +178,10 @@ Instructions for implementing each feature follow.
176178
- `basic_complete` helper method for tab completion against a list
177179
- `delimiter_complete` helper method for tab completion against a list but each match is split on a delimiter
178180
- See the [tab_autocompletion.py](https://github.com/python-cmd2/cmd2/blob/master/examples/tab_autocompletion.py) example for a demonstration of how to use this feature
179-
- `cmd2` also provides the `ACArgumentParser` customization of `argparse.ArgumentParser` for use with commands that utilize the `argparse` decorators
180-
- This class provides several advanced capabilities for automatic tab-completion
181+
- `cmd2` in combination with `argparse` also provide several advanced capabilities for automatic tab-completion
181182
- See the [tab_autocompletion.py](https://github.com/python-cmd2/cmd2/blob/master/examples/tab_autocompletion.py) and
182183
[tab_autocomp_dynamic.py](https://github.com/python-cmd2/cmd2/blob/master/examples/tab_autocomp_dynamic.py) examples for more info
184+
183185
- Multi-line commands
184186

185187
Any command accepts multi-line input when its name is listed in `Cmd.multiline_commands`.

0 commit comments

Comments
 (0)