summaryrefslogtreecommitdiffstats
path: root/Doc
diff options
context:
space:
mode:
Diffstat (limited to 'Doc')
-rw-r--r--Doc/library/optparse.rst26
1 files changed, 19 insertions, 7 deletions
diff --git a/Doc/library/optparse.rst b/Doc/library/optparse.rst
index 9527d35..1e66d4d 100644
--- a/Doc/library/optparse.rst
+++ b/Doc/library/optparse.rst
@@ -51,7 +51,9 @@ Additionally, users can run one of ::
<yourscript> -h
<yourscript> --help
-and :mod:`optparse` will print out a brief summary of your script's options::
+and :mod:`optparse` will print out a brief summary of your script's options:
+
+.. code-block:: text
usage: <yourscript> [options]
@@ -126,12 +128,16 @@ option argument
an argument that follows an option, is closely associated with that option,
and is consumed from the argument list when that option is. With
:mod:`optparse`, option arguments may either be in a separate argument from
- their option::
+ their option:
+
+ .. code-block:: text
-f foo
--file foo
- or included in the same argument::
+ or included in the same argument:
+
+ .. code-block:: text
-ffoo
--file=foo
@@ -476,7 +482,9 @@ user-friendly (documented) options::
If :mod:`optparse` encounters either ``"-h"`` or ``"--help"`` on the
command-line, or if you just call :meth:`parser.print_help`, it prints the
-following to standard output::
+following to standard output:
+
+.. code-block:: text
usage: <yourscript> [options] arg1 arg2
@@ -549,7 +557,9 @@ parser is easy::
group.add_option("-g", action="store_true", help="Group option.")
parser.add_option_group(group)
-This would result in the following help output::
+This would result in the following help output:
+
+.. code-block:: text
usage: [options] arg1 arg2
@@ -1126,7 +1136,9 @@ must specify for any option using that action.
If :mod:`optparse` sees either ``"-h"`` or ``"--help"`` on the command line,
it will print something like the following help message to stdout (assuming
- ``sys.argv[0]`` is ``"foo.py"``)::
+ ``sys.argv[0]`` is ``"foo.py"``):
+
+ .. code-block:: text
usage: foo.py [options]
@@ -1848,7 +1860,7 @@ would result in a list ::
Again we define a subclass of Option::
- class MyOption (Option):
+ class MyOption(Option):
ACTIONS = Option.ACTIONS + ("extend",)
STORE_ACTIONS = Option.STORE_ACTIONS + ("extend",)