diff options
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 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 |