[Python-Dev] Markup of command-line options in Python's .rst documentation
Éric Araujo
merwok at netwok.org
Sat Jul 17 15:44:04 CEST 2010
> The "--help" option appears as a hyperlink leading to
> http://docs.python.org/dev/py3k/using/cmdline.html#cmdoption--help, which is
> hardly relevant or useful. [...]
>
> -h/:option:`--help`
> print a short usage message and exit
I think this is a doc bug in Doc/documenting/markup.rst
:cmdoption: and :option: are not clearly distinguished; the latter
creates references to using/cmdline, the former is what you’re looking
for for documenting trace.py.
Regards
More information about the Python-Dev
mailing list