]> granicus.if.org Git - python/commitdiff
Document new "cmdoption" directive.
authorGeorg Brandl <georg@python.org>
Sat, 20 Oct 2007 13:36:24 +0000 (13:36 +0000)
committerGeorg Brandl <georg@python.org>
Sat, 20 Oct 2007 13:36:24 +0000 (13:36 +0000)
Doc/documenting/markup.rst

index f85158b163f3257fe8acb9539bf670f1ab205e6f..618e7dada7527e51b7929fbba4aa8ce0c74ecc08 100644 (file)
@@ -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: