[issue10405] IDLE breakpoint facility undocumented
New submission from Ned Deily <nad@acm.org>: In neither the IDLE section of the Library Reference nor in IDLE's own help file is there any documentation on how to use its breakpoint capability. Since the menu options only appear if the user knows to Right-click (or Control-click on OS X - see issue10404), it would be easy for a user to never realize that the breakpoint capability exists. ---------- assignee: docs@python components: Documentation, IDLE messages: 121121 nosy: docs@python, kbk, ned.deily, taleinat, terry.reedy priority: normal severity: normal status: open title: IDLE breakpoint facility undocumented versions: Python 2.7, Python 3.1, Python 3.2 _______________________________________ Python tracker <report@bugs.python.org> <http://bugs.python.org/issue10405> _______________________________________
Éric Araujo <merwok@netwok.org> added the comment: Can you propose a patch, as a diff or even plain English in a reply? ---------- nosy: +eric.araujo _______________________________________ Python tracker <report@bugs.python.org> <http://bugs.python.org/issue10405> _______________________________________
Ned Deily <nad@acm.org> added the comment: I'd rather see the wording come from more experienced users of IDLE and on other platforms. ---------- _______________________________________ Python tracker <report@bugs.python.org> <http://bugs.python.org/issue10405> _______________________________________
Nick ODell <nickodell@gmail.com> added the comment: I've added a short note regarding breakpoints in Doc/library/idle.rst Ned, I'm not an experienced user with IDLE by any means, but I think some documentation is better than none, no? ---------- nosy: +Nick.ODell Added file: http://bugs.python.org/file22268/idle.rst _______________________________________ Python tracker <report@bugs.python.org> <http://bugs.python.org/issue10405> _______________________________________
Changes by Todd Rovito <rovitotv@gmail.com>: ---------- nosy: +Todd.Rovito _______________________________________ Python tracker <report@bugs.python.org> <http://bugs.python.org/issue10405> _______________________________________
Todd Rovito added the comment: Nick, I agree some documentation is better than none. But somebody could do better I am not sure how to debug in IDLE. I have taken your file and created a 2.7 patch. ---------- keywords: +patch type: -> enhancement versions: -Python 3.1, Python 3.2 Added file: http://bugs.python.org/file27627/IDLEBreakPointDocumentation2point7.patch _______________________________________ Python tracker <report@bugs.python.org> <http://bugs.python.org/issue10405> _______________________________________
Changes by Todd Rovito <rovitotv@gmail.com>: Removed file: http://bugs.python.org/file27627/IDLEBreakPointDocumentation2point7.patch _______________________________________ Python tracker <report@bugs.python.org> <http://bugs.python.org/issue10405> _______________________________________
Todd Rovito added the comment: This patch works for both Python 3.4 and Python 2.7, it is a very simple patch. ---------- versions: +Python 3.4 Added file: http://bugs.python.org/file27628/IDLEBreakPointDocumentation.patch _______________________________________ Python tracker <report@bugs.python.org> <http://bugs.python.org/issue10405> _______________________________________
Roundup Robot added the comment: New changeset c0a423ce4b96 by Ned Deily in branch '2.7': Issue #10405: Document IDLE context menus in Standard Library document http://hg.python.org/cpython/rev/c0a423ce4b96 New changeset 566b7574becb by Ned Deily in branch '3.2': Issue #10405: Document IDLE context menus in Standard Library document http://hg.python.org/cpython/rev/566b7574becb New changeset 85c4d21f7454 by Ned Deily in branch '3.3': Issue #10405: merge from 3.2 http://hg.python.org/cpython/rev/85c4d21f7454 New changeset ea7849650fd1 by Ned Deily in branch 'default': Issue #10405: merge from 3.3 http://hg.python.org/cpython/rev/ea7849650fd1 ---------- nosy: +python-dev _______________________________________ Python tracker <report@bugs.python.org> <http://bugs.python.org/issue10405> _______________________________________
Ned Deily added the comment: Thanks for your suggestions, Nick and Todd. While reviewing them, I realized that there is also a small context (right-click) menu for the IDLE shell window as well. I expanded the doc changes to include it and included several other minor doc updates. I also updated the builtin IDLE Help file. By the way, if you haven't already and wish to contribute patches, please be sure to sign a PSF contributor agreement (http://www.python.org/psf/contrib/). ---------- resolution: -> fixed stage: -> committed/rejected status: open -> closed type: enhancement -> versions: +Python 3.2, Python 3.3 _______________________________________ Python tracker <report@bugs.python.org> <http://bugs.python.org/issue10405> _______________________________________
participants (5)
-
Ned Deily -
Nick ODell
-
Roundup Robot
-
Todd Rovito
-
Éric Araujo