From: Georg Brandl <georg@python.org>
Date: Sat, 20 Oct 2007 13:36:24 +0000 (+0000)
Subject: Document new "cmdoption" directive.
X-Git-Tag: v2.6a1~1162
X-Git-Url: https://granicus.if.org/sourcecode?a=commitdiff_plain;h=dd197e95c7ce9fca2438aeee32c6a9741b4f500f;p=python

Document new "cmdoption" directive.
---

diff --git a/Doc/documenting/markup.rst b/Doc/documenting/markup.rst
index f85158b163..618e7dada7 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: