diff options
| author | Georg Brandl <georg@python.org> | 2010-07-19 06:57:52 (GMT) |
|---|---|---|
| committer | Georg Brandl <georg@python.org> | 2010-07-19 06:57:52 (GMT) |
| commit | a5ed401688ed3146b0c80423b2c7bd9f80278e1d (patch) | |
| tree | fa5565aab687586ff29dabaef4806e4483ac52f4 /Doc/documenting | |
| parent | 70f355d13e35867482b65a6a2095abe50b21d7d8 (diff) | |
| download | cpython-a5ed401688ed3146b0c80423b2c7bd9f80278e1d.zip cpython-a5ed401688ed3146b0c80423b2c7bd9f80278e1d.tar.gz cpython-a5ed401688ed3146b0c80423b2c7bd9f80278e1d.tar.bz2 | |
Clarify :option: description.
Diffstat (limited to 'Doc/documenting')
| -rw-r--r-- | Doc/documenting/markup.rst | 5 |
1 files changed, 3 insertions, 2 deletions
diff --git a/Doc/documenting/markup.rst b/Doc/documenting/markup.rst index 25d1457..34c3fe5 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 |