summaryrefslogtreecommitdiffstats
path: root/Doc/documenting/markup.rst
diff options
context:
space:
mode:
authorGeorg Brandl <georg@python.org>2010-08-01 21:32:08 (GMT)
committerGeorg Brandl <georg@python.org>2010-08-01 21:32:08 (GMT)
commit861b522045159de57da225ac06a12d891a2647ef (patch)
tree5d7f571545d1c662102c338ee3f763664397907c /Doc/documenting/markup.rst
parent65c7d1405ebba6b25db8851ed4d4873657b80fa2 (diff)
downloadcpython-861b522045159de57da225ac06a12d891a2647ef.zip
cpython-861b522045159de57da225ac06a12d891a2647ef.tar.gz
cpython-861b522045159de57da225ac06a12d891a2647ef.tar.bz2
Merged revisions 82871,82960-82961 via svnmerge from
svn+ssh://svn.python.org/python/branches/py3k ........ r82871 | georg.brandl | 2010-07-14 10:00:22 +0200 (Mi, 14 Jul 2010) | 1 line #9258: fix copy-paste errors. ........ r82960 | georg.brandl | 2010-07-19 08:52:35 +0200 (Mo, 19 Jul 2010) | 1 line Clarify. ........ r82961 | georg.brandl | 2010-07-19 08:57:52 +0200 (Mo, 19 Jul 2010) | 1 line Clarify :option: description. ........
Diffstat (limited to 'Doc/documenting/markup.rst')
-rw-r--r--Doc/documenting/markup.rst5
1 files changed, 3 insertions, 2 deletions
diff --git a/Doc/documenting/markup.rst b/Doc/documenting/markup.rst
index dd33e81..34a79d4 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.
+ 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