Repository navigation
IDLE: Improve and document help doc viewer #77577
Description
| BPO | 33396 |
|---|---|
| Nosy | @terryjreedy, @csabella |
| Dependencies |
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 = 'https://github.com/terryjreedy'
closed_at = None
created_at = <Date 2018-05-01.04:07:44.476>
labels = ['3.8', 'expert-IDLE', 'type-feature', '3.7']
title = 'IDLE: Improve and document help doc viewer'
updated_at = <Date 2018-10-28.20:33:56.137>
user = 'https://github.com/terryjreedy'bugs.python.org fields:
activity = <Date 2018-10-28.20:33:56.137>
actor = 'terry.reedy'
assignee = 'terry.reedy'
closed = False
closed_date = None
closer = None
components = ['IDLE']
creation = <Date 2018-05-01.04:07:44.476>
creator = 'terry.reedy'
dependencies = ['33397', '34548', '35093']
files = []
hgrepos = []
issue_num = 33396
keywords = []
message_count = 4.0
messages = ['315982', '317586', '326126', '328742']
nosy_count = 2.0
nosy_names = ['terry.reedy', 'cheryl.sabella']
pr_nums = []
priority = 'normal'
resolution = None
stage = None
status = 'open'
superseder = None
type = 'enhancement'
url = 'https://bugs.python.org/issue33396'
versions = ['Python 3.6', 'Python 3.7', 'Python 3.8']Metadata
Metadata
Assignees
Projects
- Status
Activity
terryjreedy commentedon May 1, 2018
The IDLE help doc viewer displays help.html in a tk Text subclass. This index issue follows bpo-25198, which fixed three immediate issues, and left the following for later. When tackled, the items below should be separate issues and PRs listed as dependencies.
New items:
Add Help Doc Viewer doc to Help section.
I prefer not adding a menu and see an entry as an alternative.
1, 3, and 4 should try to avoid duplicating editor code. Perhaps we should enhance the plain text viewer and use it as a superclass for both base editor and html viewer.
terryjreedy commentedon May 24, 2018
Point 1 is bpo-33397.
terryjreedy commentedon Sep 23, 2018
Use configured colors. bpo-34548 does this for text viewer, so would be automatic if subclass from that.
Upgrade text viewer to include 1, 3, and 4. It also should use proportional font that help viewer uses.
10 Can Scripts/rst2html be used to directly generate idlelib/help.html from Doc/library/idle.rst?
terryjreedy commentedon Oct 28, 2018
bpo-35093 implements item 6, (initially) doc the help viewer. When we improve the help viewer, we should revise the doc at the same time.
(I unlinked comment with wrong issue number.)