[docs] [issue9312] Fix usage of :option: markup in stdlib ReST docs
report at bugs.python.org
Sat Aug 7 15:37:42 CEST 2010
Eli Bendersky <eliben at gmail.com> added the comment:
Following the discussions on pydev and some private correspondence with Georg Brandl, I'm attaching an updated patch.
1. Changes of :option: to ``...`` similar to previous patch
2. :program:`prog` :option:`opt` was changed to ``prog opt``
3. Some modules have a large choice of command line options. Per Georg's suggestions, command line options in these modules can be described with the "cmdoption" directive and later referred to with :option: which inserts a back-link, just like to the Python interpreter options now. I've applied these changes to unittest.rst and timeit.rst. trace.rst also has this problem, but the trace documentation is currently undergoing a major change by issue 9264 (2.6 fix was already committed) and I prefer changing it wholly at once.
In addition, the documentation of optparse underwent a more serious change because it kept referring to options with ``"-o"`` (note the double quotes after the ``), I changed it to ``-o`` for consistency.
P.S. The patch was generated from a fresh pull of py3k from the Hg mirror. The complete list of affected files:
Added file: http://bugs.python.org/file18424/issue9312.2.patch
Python tracker <report at bugs.python.org>
More information about the docs