diff options
| author | Georg Brandl <georg@python.org> | 2007-10-20 13:36:24 (GMT) |
|---|---|---|
| committer | Georg Brandl <georg@python.org> | 2007-10-20 13:36:24 (GMT) |
| commit | dd197e95c7ce9fca2438aeee32c6a9741b4f500f (patch) | |
| tree | fea61d13cc30f7aa8c27b3352ad0851a5c26b248 /Doc/documenting | |
| parent | ff27e0cd10b663cc5dec64be91c74ca232e81e81 (diff) | |
| download | cpython-dd197e95c7ce9fca2438aeee32c6a9741b4f500f.zip cpython-dd197e95c7ce9fca2438aeee32c6a9741b4f500f.tar.gz cpython-dd197e95c7ce9fca2438aeee32c6a9741b4f500f.tar.bz2 | |
Document new "cmdoption" directive.
Diffstat (limited to 'Doc/documenting')
| -rw-r--r-- | Doc/documenting/markup.rst | 8 |
1 files changed, 8 insertions, 0 deletions
diff --git a/Doc/documenting/markup.rst b/Doc/documenting/markup.rst index f85158b..618e7da 100644 --- a/Doc/documenting/markup.rst +++ b/Doc/documenting/markup.rst @@ -212,6 +212,14 @@ The directives are: Describes a Python bytecode instruction. +.. describe:: cmdoption + + Describes a command line option or switch. Option argument names should be + enclosed in angle brackets. Example:: + + .. cmdoption:: -m <module> + + Run a module as a script. There is also a generic version of these directives: |