diff options
| author | Kevin Van Brunt <kmvanbrunt@gmail.com> | 2020-04-23 18:01:23 -0400 |
|---|---|---|
| committer | Kevin Van Brunt <kmvanbrunt@gmail.com> | 2020-04-23 18:01:23 -0400 |
| commit | 502fdff29b755bec83808352db8777e6e1057757 (patch) | |
| tree | 33169eca113b07a891ef4fcdb70a4bb409b5b4a4 | |
| parent | e21e2ef271bed4681ec09ee2643f4b9a4e54ca8e (diff) | |
| download | cmd2-git-502fdff29b755bec83808352db8777e6e1057757.tar.gz | |
Completion doc updates
| -rw-r--r-- | cmd2/argparse_custom.py | 21 | ||||
| -rw-r--r-- | docs/features/completion.rst | 3 |
2 files changed, 11 insertions, 13 deletions
diff --git a/cmd2/argparse_custom.py b/cmd2/argparse_custom.py index 5c3d6223..f018f33f 100644 --- a/cmd2/argparse_custom.py +++ b/cmd2/argparse_custom.py @@ -188,18 +188,15 @@ and will not include the description value of the CompletionItems. **Patched argparse functions** -argparse._ActionsContainer.add_argument - adds arguments related to tab - completion and enables nargs range - parsing See _add_argument_wrapper for - more details on these argument - -argparse.ArgumentParser._get_nargs_pattern - adds support to for nargs ranges - See _get_nargs_pattern_wrapper for - more details - -argparse.ArgumentParser._match_argument - adds support to for nargs ranges See - _match_argument_wrapper for more - details +``argparse._ActionsContainer.add_argument`` - adds arguments related to tab +completion and enables nargs range parsing. See _add_argument_wrapper for +more details on these arguments. + +``argparse.ArgumentParser._get_nargs_pattern`` - adds support to for nargs +ranges. See _get_nargs_pattern_wrapper for more details. + +``argparse.ArgumentParser._match_argument`` - adds support to for nargs ranges. +See _match_argument_wrapper for more details. """ import argparse diff --git a/docs/features/completion.rst b/docs/features/completion.rst index 51e5d73c..77a51136 100644 --- a/docs/features/completion.rst +++ b/docs/features/completion.rst @@ -135,4 +135,5 @@ See the argparse_completion_ example or the implementation of the built-in For More Information -------------------- -See :mod:`cmd2.argparse_custom` for more details. +See :mod:`cmd2.argparse_custom` for a more detailed discussion of argparse +completion. |