Terry J. Reedy added the comment: The patch generally changes things like :option:`-e` to ``-e`` and -r N/:option:`--repeat=N` to ``-r N/--repeat=N`` which is what I understand GB to have said to do. :program:`python regrtest.py` :option:`test_spam.py` to :program:`python regrtest.py test_spam.py` For the last, I presume that :program:`...` takes the place of ``...`` in the previous examples. There are a few text changes in doctest.rst that I cannot comment on. I presume this could and should be backported from 3.2 to other versions. Eli said in email that he has run 'make html' and checked the output. ---------- nosy: +tjreedy stage: -> commit review versions: +Python 2.6, Python 2.7, Python 3.1 _______________________________________ Python tracker http://bugs.python.org/issue9312 _______________________________________

Eli Bendersky added the comment: Terry, Re doctest.rst - appears to be a merging issue. I will see how to resolve it once we figure out what to do with :program: Éric, Good point - I'll ask pydev and will update the patch accordingly ---------- _______________________________________ Python tracker http://bugs.python.org/issue9312 _______________________________________

Eli Bendersky added the comment: Following the discussions on pydev and some private correspondence with Georg Brandl, I'm attaching an updated patch. Things changed: 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: M Doc/library/codecs.rst M Doc/library/compileall.rst M Doc/library/doctest.rst M Doc/library/exceptions.rst M Doc/library/getopt.rst M Doc/library/idle.rst M Doc/library/optparse.rst M Doc/library/pydoc.rst M Doc/library/sys.rst M Doc/library/test.rst M Doc/library/timeit.rst M Doc/library/unittest.rst M Doc/library/webbrowser.rst ---------- nosy: +georg.brandl Added file: http://bugs.python.org/file18424/issue9312.2.patch _______________________________________ Python tracker http://bugs.python.org/issue9312 _______________________________________

Eli Bendersky added the comment: Eric, thanks for the catch and the fix. If there's anything else, just let me know. ---------- _______________________________________ Python tracker http://bugs.python.org/issue9312 _______________________________________

Éric Araujo added the comment: I hope the patch is not outdated. Terry, Georg, are you okay with it? ---------- versions: -Python 2.6 _______________________________________ Python tracker http://bugs.python.org/issue9312 _______________________________________

Terry J. Reedy added the comment: Ok with me also to commit and backport for next releases. ---------- _______________________________________ Python tracker http://bugs.python.org/issue9312 _______________________________________

Changes by Georg Brandl : Removed file: http://bugs.python.org/file19577/unnamed _______________________________________ Python tracker http://bugs.python.org/issue9312 _______________________________________

Éric Araujo added the comment: Can I commit doc patches like this one despite the branch freeze? ---------- assignee: docs@python -> eric.araujo resolution: -> accepted status: open -> pending _______________________________________ Python tracker http://bugs.python.org/issue9312 _______________________________________

Changes by Éric Araujo : ---------- status: open -> pending _______________________________________ Python tracker http://bugs.python.org/issue9312 _______________________________________

Eli Bendersky added the comment: Éric, 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 http://bugs.python.org/issue9312 _______________________________________

Georg Brandl added the comment: Yes, you're right; you could have linked to the correct -c option by using this form: :option:`unittest -c` ---------- _______________________________________ Python tracker http://bugs.python.org/issue9312 _______________________________________

Éric Araujo added the comment: I removed one instance of unnecessary markup in r87294 (pointed by Michael Foord on IRC) and made other minor changes in r87296, r87300 and r87302. Those eight commits are now merged in 3.1 as r87305 and 2.7 as r87308. Please let me know if you find any merge glitches. Happily closing. ---------- status: open -> closed _______________________________________ Python tracker http://bugs.python.org/issue9312 _______________________________________

Roundup Robot added the comment: New changeset 7164bdfa0b0b by Éric Araujo in branch '2.7': Fix a few misuses of :option: I missed in r86521. http://hg.python.org/cpython/rev/7164bdfa0b0b ---------- _______________________________________ Python tracker http://bugs.python.org/issue9312 _______________________________________