Clarify :option: description.

a5ed4016 · Georg Brandl · 70f355d1 · a5ed4016
Commit a5ed4016 authored Jul 19, 2010 by Georg Brandl
Hide whitespace changes
Inline Side-by-side

Showing with 3 additions and 2 deletions

Doc/documenting/markup.rst Doc/documenting/markup.rst +3 -2

No files found.
--- 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