Skip to content

Commit 7db2786

Browse files
committed
Added more documentation
1 parent 61d95b7 commit 7db2786

File tree

1 file changed

+3
-1
lines changed

1 file changed

+3
-1
lines changed

docs/argument_processing.rst

Lines changed: 3 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -9,7 +9,9 @@ Argument Processing
99

1010
1. Parsing input and quoted strings like the Unix shell
1111
2. Parse the resulting argument list using an instance of ``argparse.ArgumentParser`` that you provide
12-
3. Passes the resulting ``argparse.Namespace`` object to your command function
12+
3. Passes the resulting ``argparse.Namespace`` object to your command function. The ``Namespace`` includes the
13+
``Statement`` object that was parsed from the command line. It is stored in the ``__statement__`` attribute of
14+
the ``Namespace``.
1315
4. Adds the usage message from the argument parser to your command.
1416
5. Checks if the ``-h/--help`` option is present, and if so, display the help message for the command
1517

0 commit comments

Comments
 (0)