[Python-checkins] r82961 - python/branches/py3k/Doc/documenting/markup.rst

georg.brandl python-checkins at python.org
Mon Jul 19 08:57:52 CEST 2010


Author: georg.brandl
Date: Mon Jul 19 08:57:52 2010
New Revision: 82961

Log:
Clarify :option: description.

Modified:
   python/branches/py3k/Doc/documenting/markup.rst

Modified: python/branches/py3k/Doc/documenting/markup.rst
==============================================================================
--- python/branches/py3k/Doc/documenting/markup.rst	(original)
+++ python/branches/py3k/Doc/documenting/markup.rst	Mon Jul 19 08:57:52 2010
@@ -502,8 +502,9 @@
 
 .. describe:: option
 
-   A command-line option to an executable program.  The leading hyphen(s) must
-   be included.  If a matching ``cmdoption`` directive exists, it is linked to.
+   A command-line option of Python.  The leading hyphen(s) must be included.
+   If a matching ``cmdoption`` directive exists, it is linked to.  For options
+   of other programs or scripts, use simple ````code```` markup.
 
 .. describe:: program
 


More information about the Python-checkins mailing list