[issue9264] trace.py documentation is incomplete

Éric Araujo added the comment: Nesting of class/method and class/data directives recommended in 584f9c213a6d. -- ___ Python tracker ___ __

[issue9264] trace.py documentation is incomplete

Éric Araujo added the comment: Backported in r88324 and r88328. -- resolution: accepted -> fixed stage: patch review -> committed/rejected status: pending -> closed ___ Python tracker __

[issue9264] trace.py documentation is incomplete

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

[issue9264] trace.py documentation is incomplete

Georg Brandl added the comment: Yes, it's the new recommended style. (Please add to documenting/ when convenient :) -- nosy: +georg.brandl ___ Python tracker ___ __

[issue9264] trace.py documentation is incomplete

Éric Araujo added the comment: The nesting allows logical grouping in source and output, saves a bit of typing, and has been added to a number of files by Benjamin Peterson. I’d say it’s recommended :) -- status: pending -> open ___ Python tracker

[issue9264] trace.py documentation is incomplete

Eli Bendersky added the comment: Éric, The nested methods are nice, though a bit unusual IMHO. Is this the recommended new way to markup methods of objects? [Because AFAIK it's not used much in other docs] -- status: open -> pending ___ Python tra

[issue9264] trace.py documentation is incomplete

Éric Araujo added the comment: Minor whitespace and markup edits make r87273. Please review and tell me if it’s okay for backport or if there are further improvements to be done first. I promise I won’t beat anyone ;-) -- ___ Python tracker

[issue9264] trace.py documentation is incomplete

Terry J. Reedy added the comment: Éric beat me. Better that he finish. -- ___ Python tracker ___ ___ Python-bugs-list mailing list Uns

[issue9264] trace.py documentation is incomplete

Éric Araujo added the comment: My current schedule is a bit crazy and I’ve had no time for Python bugs. I changed “programming” to “programmatic”, slightly tweaked the phrasing for the --ignore-* options to make them hopefully more understandable and similar, and committed in r87271. I’m cur

[issue9264] trace.py documentation is incomplete

Terry J. Reedy added the comment: Since Éric grabbed Assigned To:, I was expecting him to ;=). But since he is doing enough other stuff, I will unless there are conflicts in the .rst I do not know how to fix. -- status: pending -> open ___ Python t

[issue9264] trace.py documentation is incomplete

Changes by Eli Bendersky : -- status: open -> pending ___ Python tracker ___ ___ Python-bugs-list mailing list Unsubscribe: http://mai

[issue9264] trace.py documentation is incomplete

Eli Bendersky added the comment: Guys, this issue is pending for a long time. Anything else needed before a commit is done? -- status: pending -> open ___ Python tracker ___ ___

[issue9264] trace.py documentation is incomplete

Changes by Éric Araujo : -- assignee: terry.reedy -> eric.araujo status: open -> pending versions: +Python 3.1 ___ Python tracker ___ _

[issue9264] trace.py documentation is incomplete

Terry J. Reedy added the comment: Éric, please feel free to commit (and even grab Assigned To:) when you feel patch is ready. You can do final review better than me. -- versions: -Python 3.1 ___ Python tracker __

[issue9264] trace.py documentation is incomplete

Éric Araujo added the comment: Duh, I forgot some words: The file uses one or two dots *after full stops* inconsistently. I don’t think you have to change that now, we can make it consistent later (or not, as it does not affect the output), as we do with line wrapping. Just keep it in mind

[issue9264] trace.py documentation is incomplete

Eli Bendersky added the comment: Attaching an updated patch following Éric's suggestions: * ``dir/package/module.cover`` -- FIXED * '``>>``' looks wrong -- FIXED to just ``>>`` * ``os.pathsep`` -- FIXED * method:: CoverageResults.update(other) -- OK, let's leave it for a separate is

[issue9264] trace.py documentation is incomplete

Éric Araujo added the comment: Thanks for your work on this! ``dir/package/module.cover`` → :file:`{dir}/{package}/{module}.cover` '``>>``' looks wrong. ``os.pathsep``: You can use :data:`os.pathsep` to get a link, I think. +.. method:: CoverageResults.update(other) FTR, there is a new w

[issue9264] trace.py documentation is incomplete

Eli Bendersky added the comment: Attaching an updated patch for Doc/library/trace.rst in 3.2 Changed the formatting of command-line options per Éric's suggestion of using program/cmdoption/option combos (great idea Éric - it looks much better). -- Added file: http://bugs.python.org/fi

[issue9264] trace.py documentation is incomplete

Eli Bendersky added the comment: Éric, I sent an inquiry about this problem to the d...@python.org list. In the meantime, I will implement it with the workaround you suggest (I checked it works in this case too). -- ___ Python tracker

[issue9264] trace.py documentation is incomplete

Éric Araujo added the comment: I noticed too that the second form given in a cmdoption directive cannot be linked to from an option construct. The workaround looks like this: :option:`--long <-l>`. This uses a generic Sphinx (or reST) property: When using :role:`text `, “thing” will be give

[issue9264] trace.py documentation is incomplete

Eli Bendersky added the comment: There's something weird going on with cmdoption... I've applied for subscription to the docs mailing list, but while I'm awaiting moderator approval, here's the brain-dump. Suppose this option description: .. program:: trace .. cmdoption:: -c, --count Bla

[issue9264] trace.py documentation is incomplete

Eli Bendersky added the comment: Éric, good idea - I'll do it. -- ___ Python tracker ___ ___ Python-bugs-list mailing list Unsubscribe

[issue9264] trace.py documentation is incomplete

Éric Araujo added the comment: > Divided command-line options logically into sub-sections and improved > their explanations Using the program/cmdoption combo may be a good idea here. -- nosy: +eric.araujo ___ Python tracker

[issue9264] trace.py documentation is incomplete

Changes by Éric Araujo : -- nosy: +d...@python -georg.brandl ___ Python tracker ___ ___ Python-bugs-list mailing list Unsubscribe: htt

[issue9264] trace.py documentation is incomplete

Eli Bendersky added the comment: Alexander, I'm submitting a patch for Doc/library/trace.rst for 3.2, incorporating the stylistic changes you propose. It would be really great to see this fixed for the next release of 3.2, since the documentation improvement is major, and it's already in for

[issue9264] trace.py documentation is incomplete

Alexander Belopolsky added the comment: > So I'm open to ideas and am willing to submit improved patches for 3.2 I offered some ideas in my last message. In addition, I would like to see profile and trace documentation to converge to similar structure and use similar terminology. In particu

[issue9264] trace.py documentation is incomplete

Eli Bendersky added the comment: Alexander, I agree that the documentation isn't yet in a perfect state and can be further improved. Since there's still time for the next milestone of 3.2, there's no reason not to improve it. So I'm open to ideas and am willing to submit improved patches for

[issue9264] trace.py documentation is incomplete

Alexander Belopolsky added the comment: The fixed up version is just r83549. It may merge cleanly with py3k - I believe doc changes are trivial if any between 2.6 and 3.x. I would like this to go through another round of reviews without release calendar pressure. I would like to see some gui

[issue9264] trace.py documentation is incomplete

Terry J. Reedy added the comment: Fine with me. Alexander, do you have the fixed up version you committed to 2.6, or should Eli revise the attachment here for 2.7? -- ___ Python tracker ___

[issue9264] trace.py documentation is incomplete

Eli Bendersky added the comment: I think it makes sense to commit the same patch to 2.7, is this planned? -- ___ Python tracker ___ __

[issue9264] trace.py documentation is incomplete

Changes by Terry J. Reedy : -- assignee: d...@python -> tjreedy nosy: -barry, d...@python stage: commit review -> patch review versions: -Python 2.6 ___ Python tracker ___ _

[issue9264] trace.py documentation is incomplete

Alexander Belopolsky added the comment: Committed in release26-maint, r83549, to beat the rc1 deadline. I'll comment on a few improvements that we can do for 3.x later. Eli, I needed to fix white space issues in your patch before committing. Please run make patchcheck on your changes befo

[issue9264] trace.py documentation is incomplete

Terry J. Reedy added the comment: I cannot do commits yet, so please do it. I expected this to be picked up by a doc person. -- ___ Python tracker ___ __

[issue9264] trace.py documentation is incomplete

Alexander Belopolsky added the comment: Oh, this is not assigned to me. Terry, do you need help with this? -- ___ Python tracker ___

[issue9264] trace.py documentation is incomplete

Alexander Belopolsky added the comment: I'll try to meet the deadline. :-) -- ___ Python tracker ___ ___ Python-bugs-list mailing list

[issue9264] trace.py documentation is incomplete

Changes by Barry A. Warsaw : -- priority: release blocker -> high ___ Python tracker ___ ___ Python-bugs-list mailing list Unsubscribe:

[issue9264] trace.py documentation is incomplete

Barry A. Warsaw added the comment: You have about 5 hours as of this writing to apply the doc patch for Python 2.6.6 rc1 and then it will be too late to get it into Python 2.6.6 (though I might make an exception for doc-only patches like this, for post rc1). While I haven't built the docs, I

[issue9264] trace.py documentation is incomplete

Changes by Alexander Belopolsky : -- nosy: +belopolsky ___ Python tracker ___ ___ Python-bugs-list mailing list Unsubscribe: http://ma

[issue9264] trace.py documentation is incomplete

Barry A. Warsaw added the comment: If the changes are to the documentation only, you've confirmed that the docs build in 2.6.6, and you get the changes in before 2.6.6rc1, then you can go ahead and commit them. I don't need to review them too closely - I trust you - but if you want me to do

[issue9264] trace.py documentation is incomplete

Terry J. Reedy added the comment: To the doc person who reads this: this patch is only the first for this issue. It is being submitted now since the 2.6.6 release candidate is due in 10 days. Please leave the issue open after committing this. I have read the diff but not the patched result (c

[issue9264] trace.py documentation is incomplete

Eli Bendersky added the comment: Attaching a patch vs. the 2.6 maintenance branch for the Doc/library/trace.rst file * Fixed some formatting issues for command line options and class references * Documented all relevant user-accessible methods * Divided command-line options logically into sub-

[issue9264] trace.py documentation is incomplete

Terry J. Reedy added the comment: I am reviewing doc + patch against the code. Do not commit yet. -- assignee: d...@python -> tjreedy stage: -> patch review ___ Python tracker _

[issue9264] trace.py documentation is incomplete

New submission from Eli Bendersky : The documentation of the standard 'trace' module (Doc/library/trace.rst) is sorely lacking. Arguments are not explained, some key methods are not documented at all, and the CoverageResults class isn't documented. Usage of these appears in the example but lea