summaryrefslogtreecommitdiff
path: root/docs/features/argument_processing.rst
diff options
context:
space:
mode:
authorkotfu <kotfu@kotfu.net>2019-07-14 21:31:23 -0600
committerkotfu <kotfu@kotfu.net>2019-07-14 21:31:23 -0600
commit9325989ae5c7aa463b34bdc6997445a9603030d4 (patch)
tree84cbbbd8131aa3bc98a9b73b96532551c998e532 /docs/features/argument_processing.rst
parentaa34722a54e2ccfd2b831624e6219464e520d834 (diff)
downloadcmd2-git-9325989ae5c7aa463b34bdc6997445a9603030d4.tar.gz
Finish migration documentation for #719
Diffstat (limited to 'docs/features/argument_processing.rst')
-rw-r--r--docs/features/argument_processing.rst7
1 files changed, 5 insertions, 2 deletions
diff --git a/docs/features/argument_processing.rst b/docs/features/argument_processing.rst
index 5efc83ef..d0f2c137 100644
--- a/docs/features/argument_processing.rst
+++ b/docs/features/argument_processing.rst
@@ -4,8 +4,9 @@ Argument Processing
===================
``cmd2`` makes it easy to add sophisticated argument processing to your
-commands using the ``argparse`` python module. ``cmd2`` handles the following
-for you:
+commands using the `argparse
+<https://docs.python.org/3/library/argparse.html>`_ python module. ``cmd2``
+handles the following for you:
1. Parsing input and quoted strings like the Unix shell
@@ -16,7 +17,9 @@ for you:
The ``Namespace`` includes the ``Statement`` object that was created when
parsing the command line. It is stored in the ``__statement__`` attribute of
the ``Namespace``.
+
4. Adds the usage message from the argument parser to your command.
+
5. Checks if the ``-h/--help`` option is present, and if so, display the help
message for the command