[docs] [issue14944] Setup & Usage documentation for pydoc, idle & 2to3

Terry J. Reedy report at bugs.python.org
Tue May 29 05:22:48 CEST 2012

Terry J. Reedy <tjreedy at 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.

tcl/tk probably already on system

mac: (ned daily)
special tcl/tk issues, special page on site

nosy: +terry.reedy

Python tracker <report at bugs.python.org>

More information about the docs mailing list