]> granicus.if.org Git - python/commitdiff
Clarify :option: description.
authorGeorg Brandl <georg@python.org>
Mon, 19 Jul 2010 06:57:52 +0000 (06:57 +0000)
committerGeorg Brandl <georg@python.org>
Mon, 19 Jul 2010 06:57:52 +0000 (06:57 +0000)
Doc/documenting/markup.rst

index 25d14579f6d36601cb8701b8d8f6835059bac2ce..34c3fe5904972c5ce23f3e9ebd48b2f5f0b5c5e8 100644 (file)
@@ -502,8 +502,9 @@ in a different style:
 
 .. 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