From: Georg Brandl <georg@python.org>
Date: Mon, 19 Jul 2010 06:57:52 +0000 (+0000)
Subject: Clarify :option: description.
X-Git-Tag: v3.2a1~168
X-Git-Url: https://granicus.if.org/sourcecode?a=commitdiff_plain;h=a5ed401688ed3146b0c80423b2c7bd9f80278e1d;p=python

Clarify :option: description.
---

diff --git a/Doc/documenting/markup.rst b/Doc/documenting/markup.rst
index 25d14579f6..34c3fe5904 100644
--- a/Doc/documenting/markup.rst
+++ b/Doc/documenting/markup.rst
@@ -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