diff options
| author | Kevin Van Brunt <kmvanbrunt@gmail.com> | 2019-11-24 22:21:34 -0500 |
|---|---|---|
| committer | Kevin Van Brunt <kmvanbrunt@gmail.com> | 2019-11-24 22:21:34 -0500 |
| commit | cb55f0bbf08a48530dcc06c0c1f5c7caafb1bab4 (patch) | |
| tree | e4fedf291724058319bbc3716be0606d9945f45e /cmd2 | |
| parent | 99f4640190baa299d3ed73b12265b356330468ac (diff) | |
| download | cmd2-git-cb55f0bbf08a48530dcc06c0c1f5c7caafb1bab4.tar.gz | |
Added documentation
Diffstat (limited to 'cmd2')
| -rw-r--r-- | cmd2/argparse_custom.py | 3 |
1 files changed, 2 insertions, 1 deletions
diff --git a/cmd2/argparse_custom.py b/cmd2/argparse_custom.py index c6aa6550..f8a9ec60 100644 --- a/cmd2/argparse_custom.py +++ b/cmd2/argparse_custom.py @@ -4,7 +4,8 @@ This module adds capabilities to argparse by patching a few of its functions. It class called Cmd2ArgumentParser which improves error and help output over normal argparse. All cmd2 code uses this parser and it is recommended that developers of cmd2-based apps either use it or write their own parser that inherits from it. This will give a consistent look-and-feel between the help/error output of built-in -cmd2 commands and the app-specific commands. +cmd2 commands and the app-specific commands. If you wish to override the parser used by cmd2's built-in +commands, see override_parser.py example. Since the new capabilities are added by patching at the argparse API level, they are available whether or not Cmd2ArgumentParser is used. However, the help and error output of Cmd2ArgumentParser is customized to notate |