diff options
author | Kevin Van Brunt <kmvanbrunt@gmail.com> | 2019-03-17 00:17:27 -0400 |
---|---|---|
committer | Kevin Van Brunt <kmvanbrunt@gmail.com> | 2019-03-17 00:17:27 -0400 |
commit | 7db2786706e3f4b5cfbf90c88c29ba1ee1f1f39c (patch) | |
tree | bc806e3d88ac9466916d193066a78601c9b49011 /docs | |
parent | 61d95b7cb39551b2ca002c0fd2285c68a02a18a1 (diff) | |
download | cmd2-git-7db2786706e3f4b5cfbf90c88c29ba1ee1f1f39c.tar.gz |
Added more documentation
Diffstat (limited to 'docs')
-rw-r--r-- | docs/argument_processing.rst | 4 |
1 files changed, 3 insertions, 1 deletions
diff --git a/docs/argument_processing.rst b/docs/argument_processing.rst index bad683bf..095b4bda 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 parsed from 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 |