[Python-checkins] r58561 - python/trunk/Doc/documenting/markup.rst

georg.brandl python-checkins at python.org
Sat Oct 20 15:36:24 CEST 2007


Author: georg.brandl
Date: Sat Oct 20 15:36:24 2007
New Revision: 58561

Modified:
   python/trunk/Doc/documenting/markup.rst
Log:
Document new "cmdoption" directive.


Modified: python/trunk/Doc/documenting/markup.rst
==============================================================================
--- python/trunk/Doc/documenting/markup.rst	(original)
+++ python/trunk/Doc/documenting/markup.rst	Sat Oct 20 15:36:24 2007
@@ -212,6 +212,14 @@
 
    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:
 


More information about the Python-checkins mailing list