[docs] [issue9312] Fix usage of :option: markup in stdlib ReST docs
report at bugs.python.org
Fri Nov 19 07:30:23 CET 2010
Eli Bendersky <eliben at gmail.com> added the comment:
I went over both the diffs and the HTML output from "make clean html" on the latest 3.2 trunk. Looks good to me!
Just a tiny nit re unittest.rst, where it says "supports three command-line options". This is the kind of comment that gets left behind when new options are added. I see no added value explicitly saying there are 3 options as opposed to "supports the following command-line options", and there's less chance for future mistakes. It's also more consistent with the list of options for "discover" a bit later in the same document. This is totally a stylistic issue, of course, so IMVHO :-)
Oh, and another thing about unittest.rst: in 24.3.9 where it says "The -c command-line option to unittest", for some reason the -c didn't get linked to the option, although I think you intended it to, since you marked it as :option:
P.S: the program/cmdoption combo idea was Georg's.
Python tracker <report at bugs.python.org>
More information about the docs