diff options
| author | Todd Leonhardt <todd.leonhardt@gmail.com> | 2019-03-17 10:53:21 -0400 |
|---|---|---|
| committer | GitHub <noreply@github.com> | 2019-03-17 10:53:21 -0400 |
| commit | e28bce263802b94a79c974ddc2540075eb5301a2 (patch) | |
| tree | b1fba35bc42562fd2cfa63b69059a666cfd5d558 /docs/argument_processing.rst | |
| parent | 3b6ed1151bc417633d2207d9ed1e20b491a4ef24 (diff) | |
| parent | 47dce297681f799c51a65b3e8420bf0c551c779b (diff) | |
| download | cmd2-git-e28bce263802b94a79c974ddc2540075eb5301a2.tar.gz | |
Merge branch 'master' into attributes
Diffstat (limited to 'docs/argument_processing.rst')
| -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..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 |