summaryrefslogtreecommitdiff
path: root/docs/argument_processing.rst
diff options
context:
space:
mode:
authorTodd Leonhardt <todd.leonhardt@gmail.com>2019-03-17 10:51:03 -0400
committerGitHub <noreply@github.com>2019-03-17 10:51:03 -0400
commit47dce297681f799c51a65b3e8420bf0c551c779b (patch)
tree6c67e6f12bef2088dd9f13b511e15e1ce2f1deae /docs/argument_processing.rst
parent0144d8ea95305b73f43d41de25389b91a30cb4e1 (diff)
parentcf7cb0c2774aae1052017a54d30c0b4252d34464 (diff)
downloadcmd2-git-47dce297681f799c51a65b3e8420bf0c551c779b.tar.gz
Merge pull request #649 from python-cmd2/cmd_line
Cmd line
Diffstat (limited to 'docs/argument_processing.rst')
-rw-r--r--docs/argument_processing.rst4
1 files changed, 3 insertions, 1 deletions
diff --git a/docs/argument_processing.rst b/docs/argument_processing.rst
index bad683bf..fc1f2433 100644
--- a/docs/argument_processing.rst
+++ b/docs/argument_processing.rst
@@ -9,7 +9,9 @@ Argument Processing
1. Parsing input and quoted strings like the Unix shell
2. Parse the resulting argument list using an instance of ``argparse.ArgumentParser`` that you provide
-3. Passes the resulting ``argparse.Namespace`` object to your command function
+3. Passes the resulting ``argparse.Namespace`` object to your command function. 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