diff options
author | kotfu <kotfu@kotfu.net> | 2019-07-16 09:45:42 -0600 |
---|---|---|
committer | GitHub <noreply@github.com> | 2019-07-16 09:45:42 -0600 |
commit | eb882b2b308bb2e09761a74007ea308b489c2d56 (patch) | |
tree | dabbaf6aa290e57c7140e4b1d32f1cd1f38bcaac /docs/features/argument_processing.rst | |
parent | 94b424e9c41f99c6eb268c6c97f09e99a8342de8 (diff) | |
parent | d68f6893396109afa0c7ca4ecfe72ecf192cfc0d (diff) | |
download | cmd2-git-eb882b2b308bb2e09761a74007ea308b489c2d56.tar.gz |
Merge pull request #720 from python-cmd2/migrating_docs
Write documentation for migrating from cmd
Diffstat (limited to 'docs/features/argument_processing.rst')
-rw-r--r-- | docs/features/argument_processing.rst | 7 |
1 files changed, 5 insertions, 2 deletions
diff --git a/docs/features/argument_processing.rst b/docs/features/argument_processing.rst index 5efc83ef..d0f2c137 100644 --- a/docs/features/argument_processing.rst +++ b/docs/features/argument_processing.rst @@ -4,8 +4,9 @@ Argument Processing =================== ``cmd2`` makes it easy to add sophisticated argument processing to your -commands using the ``argparse`` python module. ``cmd2`` handles the following -for you: +commands using the `argparse +<https://docs.python.org/3/library/argparse.html>`_ python module. ``cmd2`` +handles the following for you: 1. Parsing input and quoted strings like the Unix shell @@ -16,7 +17,9 @@ for you: 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 |