[issue14944] Setup & Usage documentation for pydoc
New submission from Nick Coghlan <ncoghlan@gmail.com>: pydoc is installed as a script by Python. It should be documented under http://docs.python.org/dev/using/index.html. ---------- assignee: docs@python components: Documentation messages: 161831 nosy: docs@python, ncoghlan priority: normal severity: normal stage: needs patch status: open title: Setup & Usage documentation for pydoc type: enhancement versions: Python 2.7, Python 3.2, Python 3.3 _______________________________________ Python tracker <report@bugs.python.org> <http://bugs.python.org/issue14944> _______________________________________
Nick Coghlan <ncoghlan@gmail.com> added the comment: Same goes for idle and 2to3. These may just be cross-references to the relevant module documentation rather than completely new text. ---------- title: Setup & Usage documentation for pydoc -> Setup & Usage documentation for pydoc, idle & 2to3 _______________________________________ Python tracker <report@bugs.python.org> <http://bugs.python.org/issue14944> _______________________________________
Terry J. Reedy <tjreedy@udel.edu> added the comment: I second the motion for IDLE. There is no module doc for it. Off the top of my head, there should be a general section that * says what it is, and that it depends on tcl/tk and tkinter install; * mentions the existent of the menu Help / IDLE help document; * gives common startup methods from command line (I forget this) or inside interpreter ('from idlelib import idle') and that one may need to use one of these to see tracebacks if Idle crashes - even if one normally uses a system-specific method to directly run as gui app. * gives other common info and trouble-shooting tips (some of this is on tracker - such as deleting user .cfg that prevents startup). * points to system specific discussions, where ever they are put. Then for each system, * tcl/tk situation * how to directly start up * location of config files Windows: (what I use) tcl/tk comes with system. ... *nix: tcl/tk probably already on system ... mac: (ned daily) special tcl/tk issues, special page on site ... ---------- nosy: +terry.reedy _______________________________________ Python tracker <report@bugs.python.org> <http://bugs.python.org/issue14944> _______________________________________
Ned Deily <nad@acm.org> added the comment: http://docs.python.org/py3k/library/idle.html (duplicates much of the IDLE help file) ---------- nosy: +ned.deily _______________________________________ Python tracker <report@bugs.python.org> <http://bugs.python.org/issue14944> _______________________________________
Terry J. Reedy <tjreedy@udel.edu> added the comment: Hmm, how did I miss that?? Well better to reference that, and maybe revise it. I believe there may also be another .txt document in idlelib. Anyway, perhaps there should first be a section on tkinter by itself, and how to get the tcl/tk it depends on. Mention that optional part of Windows install, so tkinter will likely not work if unselected from installer. ---------- _______________________________________ Python tracker <report@bugs.python.org> <http://bugs.python.org/issue14944> _______________________________________
Changes by Tshepang Lekhonkhobe <tshepang@gmail.com>: ---------- nosy: +tshepang _______________________________________ Python tracker <report@bugs.python.org> <http://bugs.python.org/issue14944> _______________________________________
Changes by A.M. Kuchling <lists@amk.ca>: ---------- nosy: +akuchling _______________________________________ Python tracker <report@bugs.python.org> <http://bugs.python.org/issue14944> _______________________________________
Changes by Terry J. Reedy <tjreedy@udel.edu>: ---------- versions: +Python 3.4 -Python 3.2 _______________________________________ Python tracker <report@bugs.python.org> <http://bugs.python.org/issue14944> _______________________________________
Mark Lawrence added the comment: I'm assuming that this still applies to 3.4 and 2.7. ---------- nosy: +BreamoreBoy versions: +Python 3.5 -Python 3.3 _______________________________________ Python tracker <report@bugs.python.org> <http://bugs.python.org/issue14944> _______________________________________
Changes by A.M. Kuchling <amk@amk.ca>: ---------- nosy: -akuchling _______________________________________ Python tracker <report@bugs.python.org> <http://bugs.python.org/issue14944> _______________________________________
Changes by Al Sweigart <asweigart@gmail.com>: ---------- nosy: +Al.Sweigart _______________________________________ Python tracker <report@bugs.python.org> <http://bugs.python.org/issue14944> _______________________________________
Terry J. Reedy added the comment: I am not sure where installed scripts are documented in Using Python. 'idle' and 'idle3' are not installed on Windows. ---------- title: Setup & Usage documentation for pydoc, idle & 2to3 -> Setup & Usage documentation for pydoc, IDLE, & 2to3 versions: +Python 3.6, Python 3.7 -Python 3.4, Python 3.5 _______________________________________ Python tracker <report@bugs.python.org> <http://bugs.python.org/issue14944> _______________________________________
Changes by Mark Lawrence <breamoreboy@gmail.com>: ---------- nosy: -BreamoreBoy _______________________________________ Python tracker <report@bugs.python.org> <http://bugs.python.org/issue14944> _______________________________________
Terry J. Reedy <tjreedy@udel.edu> added the comment: idle.html, derived from idle.rst, is now the IDLE help file. pip also has pip3 command; perhaps ensurepip should be mentioned. ---------- versions: +Python 3.8 -Python 3.6 _______________________________________ Python tracker <report@bugs.python.org> <https://bugs.python.org/issue14944> _______________________________________
participants (7)
-
A.M. Kuchling -
Al Sweigart
-
Mark Lawrence
-
Ned Deily
-
Nick Coghlan
-
Terry J. Reedy
-
Tshepang Lekhonkhobe