Repository navigation
Make IDLE doc more visible, mention in main python docs page #84910
Description
| BPO | 40733 |
|---|---|
| Nosy | @terryjreedy, @taleinat, @amaajemyfren |
| Files |
Note: these values reflect the state of the issue at the time it was migrated and might not reflect the current state.
Show more details
GitHub fields:
assignee = None
closed_at = None
created_at = <Date 2020-05-22.20:27:42.295>
labels = ['3.7', '3.8', '3.9', '3.10', 'expert-IDLE', 'type-feature', 'docs']
title = 'Make IDLE doc more visible, mention in main python docs page'
updated_at = <Date 2020-05-23.15:58:43.662>
user = 'https://bugs.python.org/phr'bugs.python.org fields:
activity = <Date 2020-05-23.15:58:43.662>
actor = 'amaajemyfren'
assignee = 'docs@python'
closed = False
closed_date = None
closer = None
components = ['Documentation', 'IDLE']
creation = <Date 2020-05-22.20:27:42.295>
creator = 'phr'
dependencies = []
files = ['49186']
hgrepos = []
issue_num = 40733
keywords = []
message_count = 7.0
messages = ['369640', '369680', '369709', '369710', '369719', '369721', '369726']
nosy_count = 5.0
nosy_names = ['terry.reedy', 'phr', 'taleinat', 'docs@python', 'amaajemyfren']
pr_nums = []
priority = 'normal'
resolution = None
stage = 'needs patch'
status = 'open'
superseder = None
type = 'enhancement'
url = 'https://bugs.python.org/issue40733'
versions = ['Python 3.7', 'Python 3.8', 'Python 3.9', 'Python 3.10']
Activity
phr commentedon May 22, 2020
The IDLE documentation is in https://docs.python.org/3/library/idle.html which is not where I'd have thought to look for it, since I think of IDLE as an application rather than a library. So I looked for it on the main docs page, docs.python.org, and didn't find it there. I ended up finding it by web search.
I guess its current location is reasonable, but maybe a link to it could be included in docs.python.org's main page left side navigation panel, or IDLE could simply be mentioned in the entry for library documentation.
[-]mention IDLE in main python ocs page[/-][+]mention IDLE in main python docs page[/+][-]mention IDLE in main python ocs page[/-][+]mention IDLE in main python docs page[/+]terryjreedy commentedon May 23, 2020
I agree that finding the online doc is slight pain. It is not listed in the Modules index because idlelib, not IDLE, is the stdlib module, and does not have a doc page. I may add one or, if possible, make the page serve as one, as part of this issue. 'IDLE' *is* in the Index, and the first link is the correct one.
I don't control and would not unilaterally change the main page. I am hesitant because I expect that there are people who would think it unfair or deceptive to especially promote IDLE this way versus other stdlib packages and non-stdlib IDEs and editors. I might subscribe to and post on python-ideas to see what other users think.
Help => IDLE Help displays an offline copy of idle.html as of the release date in a tktinker text window. Have you noticed that? Would "IDLE doc" be clearer?
I could also add label with the online url and date above the text.
[https://docs.python.org/3.x/library/idle.html as of <release date>]
20 remaining items
pythongh-84910: Change 'IDLE Help' to 'IDLE Doc'
terryjreedy commentedon Aug 11, 2022
"IDLE could simply be mentioned in the entry for library documentation." IDLE in not in the text but it in in the listing of modules and the browser search (ctrl-F for me) should find it. However, I see a place where something could be added. Will think about it.
I made the online IDLE doc accessible from the Glossary entry and from the Module index (#75510). I also changed 'IDLE Help' (in process), which was an old text doc, to 'IDLE Doc', which is a copy of the online IDLE doc.
gh-84910: Change 'IDLE Help' to 'IDLE Doc' (#95873)
pythongh-84910: Change 'IDLE Help' to 'IDLE Doc' (pythonGH-95873)
pythongh-84910: Change 'IDLE Help' to 'IDLE Doc' (pythonGH-95873)
gh-84910: Change 'IDLE Help' to 'IDLE Doc' (GH-95873)
gh-84910: Change 'IDLE Help' to 'IDLE Doc' (GH-95873)
terryjreedy commentedon Feb 4, 2025
I have not tried to add IDLE to the main doc page but have have other changes to make the doc more accessible.