summaryrefslogtreecommitdiff
path: root/README.md
diff options
context:
space:
mode:
authorTodd Leonhardt <todd.leonhardt@gmail.com>2020-11-09 20:03:40 -0500
committerGitHub <noreply@github.com>2020-11-09 20:03:40 -0500
commitd3a9a6d2fdb99f6fdec064020f7b8a4b4d4e5d13 (patch)
tree0880f7834861ab0aa95f6d8d5a0d9a1f72c0cc4d /README.md
parentd4436244b1bdfc38d611545795f5759818e94847 (diff)
parent67c18b088acb28b0ff946925c94598fcf8ea634c (diff)
downloadcmd2-git-d3a9a6d2fdb99f6fdec064020f7b8a4b4d4e5d13.tar.gz
Merge pull request #1012 from KyleKing/master
Replace `with_argparser_and_unknown_args` in docs
Diffstat (limited to 'README.md')
-rwxr-xr-xREADME.md5
1 files changed, 2 insertions, 3 deletions
diff --git a/README.md b/README.md
index 8bb8b930..946e2d1f 100755
--- a/README.md
+++ b/README.md
@@ -123,9 +123,8 @@ Instructions for implementing each feature follow.
example in conjunction with the [conditional.py](https://github.com/python-cmd2/cmd2/blob/master/examples/scripts/conditional.py) script
- Parsing commands with `argparse`
- - Two decorators provide built-in capability for using `argparse.ArgumentParser` to parse command arguments
- - `cmd2.with_argparser` - all arguments are parsed by the `ArgumentParser`
- - `cmd2.with_argparser_and_unknown_args` - any arguments not parsed by the `ArgumentParser` get passed as a list
+ - The built-in `cmd2.with_argparser` decorator will parse arguments using `argparse.ArgumentParser`
+ - Optionally, `cmd2.with_argparser(.., with_unknown_args=True)` can be used to pass all unknown arguments as a list
```Python
import argparse