diff options
| author | Kevin Van Brunt <kmvanbrunt@gmail.com> | 2019-03-17 00:52:34 -0400 |
|---|---|---|
| committer | Kevin Van Brunt <kmvanbrunt@gmail.com> | 2019-03-17 00:52:34 -0400 |
| commit | 40f75f7453c3df83d8e74a281ec1311d53b23eec (patch) | |
| tree | 58ef97822a095b085fb700c28ed7de9ba6e9ea0f /docs/argument_processing.rst | |
| parent | 7db2786706e3f4b5cfbf90c88c29ba1ee1f1f39c (diff) | |
| download | cmd2-git-40f75f7453c3df83d8e74a281ec1311d53b23eec.tar.gz | |
Updated docs and example
Diffstat (limited to 'docs/argument_processing.rst')
| -rw-r--r-- | docs/argument_processing.rst | 4 |
1 files changed, 2 insertions, 2 deletions
diff --git a/docs/argument_processing.rst b/docs/argument_processing.rst index 095b4bda..fc1f2433 100644 --- a/docs/argument_processing.rst +++ b/docs/argument_processing.rst @@ -10,8 +10,8 @@ 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. The ``Namespace`` includes the - ``Statement`` object that was parsed from the command line. It is stored in the ``__statement__`` attribute of - the ``Namespace``. + ``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 |