This issue tracker has been migrated to GitHub, and is currently read-only.
For more information, see the GitHub FAQs in the Python's Developer Guide.

classification
Title: Add idlelib module entry to doc
Type: enhancement Stage: needs patch
Components: IDLE Versions: Python 3.8, Python 3.7
process
Status: open Resolution:
Dependencies: Superseder:
Assigned To: terry.reedy Nosy List: rhettinger, terry.reedy
Priority: normal Keywords:

Created on 2017-09-01 19:24 by terry.reedy, last changed 2022-04-11 14:58 by admin.

Messages (5)
msg301145 - (view) Author: Terry J. Reedy (terry.reedy) * (Python committer) Date: 2017-09-01 19:24
If this were a new section in idle.rst, it would appear with the IDLE doc displayed by Help IDLE. Being present there has its +s and -s.  Would have to see how it works here as well as online.

In any case, it would be good to have something indexed under I in Modules index.

Content: Document python -m idlelib as command line start up.  List other entry points.  Otherwise describe as 'private implementation modules', as in idlelib.__init__.
msg301153 - (view) Author: Raymond Hettinger (rhettinger) * (Python committer) Date: 2017-09-01 20:24
See also:  http://bugs.python.org/issue31319

A cleaner command-line startup would be:  python -m idle
msg301171 - (view) Author: Terry J. Reedy (terry.reedy) * (Python committer) Date: 2017-09-02 19:30
Also document in idle doc that 'import idlelib.idle' is the programmatic API, and that icons and context menus may be available.  In any case, add more information on 'How to start IDLE'.
msg338497 - (view) Author: Terry J. Reedy (terry.reedy) * (Python committer) Date: 2019-03-20 17:08
See also #14944, about the Using doc.
msg378203 - (view) Author: Terry J. Reedy (terry.reedy) * (Python committer) Date: 2020-10-08 00:07
I closed #41968 as a duplicate of this.
History
Date User Action Args
2022-04-11 14:58:51adminsetgithub: 75510
2020-10-08 00:07:34terry.reedysetnosy: - louielu
messages: + msg378203
2020-10-08 00:07:11terry.reedylinkissue41968 superseder
2019-03-20 17:08:33terry.reedysetmessages: + msg338497
2019-03-20 16:47:35terry.reedysetassignee: terry.reedy
components: + IDLE
versions: + Python 3.8, - Python 3.6
2017-09-04 12:48:51louielusetnosy: + louielu
2017-09-02 19:30:11terry.reedysetmessages: + msg301171
2017-09-01 20:24:32rhettingersetnosy: + rhettinger
messages: + msg301153
2017-09-01 19:24:07terry.reedycreate