[issue9312] Fix usage of :option: markup in stdlib ReST docs

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

[issue9312] Fix usage of :option: markup in stdlib ReST docs

Roundup Robot added the comment: New changeset 59d785ea0039 by Éric Araujo in branch '3.2': Fix a few misuses of :option: I missed in r86521. http://hg.python.org/cpython/rev/59d785ea0039 -- nosy: +python-dev ___ Python tracker

[issue9312] Fix usage of :option: markup in stdlib ReST docs

É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 g

[issue9312] Fix usage of :option: markup in stdlib ReST docs

Éric Araujo added the comment: Great, thanks! New markup committed as r86823, long lines rewrapped in r86824 (along with a few minor touch-ups). I think we’re good now, I’ll backport shortly. -- ___ Python tracker

[issue9312] Fix usage of :option: markup in stdlib ReST docs

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 ___ __

[issue9312] Fix usage of :option: markup in stdlib ReST docs

Éric Araujo added the comment: Thanks for the review. I agree and committed changes in r86632. The problem with :option:`-c` is probably that Sphinx wants to find a “.. cmdoption:: -c” joined with the latest program directive it has seen, and thus can’t find the -c defined with a previous pr

[issue9312] Fix usage of :option: markup in stdlib ReST docs

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

[issue9312] Fix usage of :option: markup in stdlib ReST docs

Éric Araujo added the comment: Patch tweaked and committed in r86521. Gory details follow. The patch applied with only two fuzzy hunks and one rejected hunk. I did a careful review of "" → ``""`` changes and edited a number of them. I’m confident in my choices but am of course open to comme

[issue9312] Fix usage of :option: markup in stdlib ReST docs

Changes by Éric Araujo : -- status: open -> pending ___ Python tracker ___ ___ Python-bugs-list mailing list Unsubscribe: http://mail.

[issue9312] Fix usage of :option: markup in stdlib ReST docs

Changes by Éric Araujo : -- status: pending -> open Removed message: http://bugs.python.org/msg121259 ___ Python tracker ___ ___ Python

[issue9312] Fix usage of :option: markup in stdlib ReST docs

Éric Araujo added the comment: Can I commit doc patches like this one despite the branch freeze? -- assignee: d...@python -> eric.araujo resolution: -> accepted status: open -> pending ___ Python tracker _

[issue9312] Fix usage of :option: markup in stdlib ReST docs

Georg Brandl added the comment: Yes, please apply. -- ___ Python tracker ___ ___ Python-bugs-list mailing list Unsubscribe: http://ma

[issue9312] Fix usage of :option: markup in stdlib ReST docs

Changes by Georg Brandl : Removed file: http://bugs.python.org/file19577/unnamed ___ Python tracker ___ ___ Python-bugs-list mailing list Unsub

[issue9312] Fix usage of :option: markup in stdlib ReST docs

Eli Bendersky added the comment: On Fri, Nov 12, 2010 at 05:05, Terry J. Reedy wrote: Please let me know if there are problems applying it and with which versions, I will fix it up to bring it up to date. It's a tricky patch (affects many files in many places), so there might be difficulties.

[issue9312] Fix usage of :option: markup in stdlib ReST docs

Terry J. Reedy added the comment: Ok with me also to commit and backport for next releases. -- ___ Python tracker ___ ___ Python-bugs-

[issue9312] Fix usage of :option: markup in stdlib ReST docs

Ezio Melotti added the comment: Looks good to me. -- ___ Python tracker ___ ___ Python-bugs-list mailing list Unsubscribe: http://mai

[issue9312] Fix usage of :option: markup in stdlib ReST docs

É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 ___ ___

[issue9312] Fix usage of :option: markup in stdlib ReST docs

Éric Araujo added the comment: Nothing else to say, +1 on commit. -- ___ Python tracker ___ ___ Python-bugs-list mailing list Unsubscr

[issue9312] Fix usage of :option: markup in stdlib ReST docs

Eli Bendersky added the comment: Eric, thanks for the catch and the fix. If there's anything else, just let me know. -- ___ Python tracker ___ __

[issue9312] Fix usage of :option: markup in stdlib ReST docs

Éric Araujo added the comment: Nice changes! Especially the program/cmdoption directives combo. Your patch introduces trailing whitespace (good editor settings can show those, as well as hg diff with the color extension) and has one unnecessary change: -line, ``options.filename`` will be ``"o

[issue9312] Fix usage of :option: markup in stdlib ReST docs

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.

[issue9312] Fix usage of :option: markup in stdlib ReST docs

Changes by Ezio Melotti : -- nosy: +ezio.melotti ___ Python tracker ___ ___ Python-bugs-list mailing list Unsubscribe: http://mail.pyt

[issue9312] Fix usage of :option: markup in stdlib ReST docs

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 -- ___ Pytho

[issue9312] Fix usage of :option: markup in stdlib ReST docs

Éric Araujo added the comment: In documenting/markup: program The name of an executable program. This may differ from the file name for the executable for some platforms. In particular, the .exe (or other) extension should be omitted for Windows programs. So I believe the correct form wo

[issue9312] Fix usage of :option: markup in stdlib ReST docs

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 regrtes

[issue9312] Fix usage of :option: markup in stdlib ReST docs

Eli Bendersky added the comment: Patch -- keywords: +patch Added file: http://bugs.python.org/file18080/issue9312.1.patch ___ Python tracker ___ _

[issue9312] Fix usage of :option: markup in stdlib ReST docs

New submission from Eli Bendersky : Due to a discussion on python-dev (Subject: "Markup of command-line options in Python's .rst documentation"), Georg Brandl checked in revision r82961 with a clarification of :option: markup which should only be used for Python interpreter's own flags. Howev