summaryrefslogtreecommitdiff
path: root/docs/argument_processing.rst
diff options
context:
space:
mode:
authorTodd Leonhardt <todd.leonhardt@gmail.com>2018-01-10 20:29:02 -0500
committerTodd Leonhardt <todd.leonhardt@gmail.com>2018-01-10 20:29:02 -0500
commit0a03ab88f8bb70cc2f384c0b98a18bdead7bd417 (patch)
treefeff7ba223d73f23b60feded820975b74e036ee2 /docs/argument_processing.rst
parent38312dead63ea9d95cdb7f7b34a4d6030dbf0479 (diff)
downloadcmd2-git-0a03ab88f8bb70cc2f384c0b98a18bdead7bd417.tar.gz
Trivial doc change to get readthedocs to rebuild
Diffstat (limited to 'docs/argument_processing.rst')
-rw-r--r--docs/argument_processing.rst5
1 files changed, 3 insertions, 2 deletions
diff --git a/docs/argument_processing.rst b/docs/argument_processing.rst
index 79c19d19..f2cd394b 100644
--- a/docs/argument_processing.rst
+++ b/docs/argument_processing.rst
@@ -2,7 +2,8 @@
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:
+``cmd2`` makes it easy to add sophisticated argument processing to your commands using the ``argparse`` python module.
+``cmd2`` handles the following for you:
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
@@ -80,7 +81,7 @@ The ``help tag`` command displays:
optional arguments:
-h, --help show this help message and exit
-
+
If you would prefer the short description of your command to come after the usage message, leave the docstring on your method empty, but supply a ``description`` variable to the argument parser::
argparser = argparse.ArgumentParser(description='create an html tag')