IDLE doc improvements

@terryjreedy

BPO	37825
Nosy	@terryjreedy, @taleinat

^{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 2019-08-11.16:54:19.592>
labels = ['expert-IDLE', '3.7', '3.8', '3.9']
title = 'IDLE doc improvements'
updated_at = <Date 2019-09-10.02:45:02.350>
user = 'https://github.com/terryjreedy'

bugs.python.org fields:

activity = <Date 2019-09-10.02:45:02.350>
actor = 'terry.reedy'
assignee = 'terry.reedy'
closed = False
closed_date = None
closer = None
components = ['IDLE']
creation = <Date 2019-08-11.16:54:19.592>
creator = 'terry.reedy'
dependencies = []
files = []
hgrepos = []
issue_num = 37825
keywords = []
message_count = 5.0
messages = ['349399', '349427', '349435', '349436', '351565']
nosy_count = 2.0
nosy_names = ['terry.reedy', 'taleinat']
pr_nums = []
priority = 'normal'
resolution = None
stage = 'needs patch'
status = 'open'
superseder = None
type = None
url = 'https://bugs.python.org/issue37825'
versions = ['Python 3.7', 'Python 3.8', 'Python 3.9']

Headings: Sections should be titlecased, subsections not. This is especially needed now that they are not numbered.
Python Shell subsection. Revise 'paste', maybe move. SyntaxWarnings are SyntaxErrors. Explain Restart.
Any other pending changes I include.

Because the scope of SyntaxWarnings has been expanded to code that must be run, they should no longer be turned into errors, so this should not be added to the doc. See bpo-34857.

Completions subsection: fix this garbled sentence. "Names in an Editor window which are not via __main__ and sys.modules will not be found." Check 2.6 help.txt from whence it likely came.

The garble was in help.txt as copied into idle.rst in bpo-5066. I will have to figure out the meaning.

5 Delete use of 'extension' referring to converted features.
"If you don’t like the ACW popping up unbidden, simply make the delay longer or disable the extension." Remove ' or ...'

Points 4 and 5 are already done. Upcoming PR addresses 1 and 2. The parsing in help.py needs revision due to changes in the generated help.html.

pythongh-82006: IDLE doc improvements

gh-82006: IDLE doc improvements (#94349)

pythongh-82006: IDLE doc improvements (pythonGH-94349)

gh-82006: IDLE doc improvements (GH-94349)

[3.10] gh-82006: IDLE doc improvements (GH-94349) (GH-94358)

Glitch in original patch fixed in #94366 and #94369 and in 3.10 backport of original.

pythongh-82006: IDLE doc improvements (python#94349)

Navigation Menu

Repository navigation

IDLE doc improvements #82006

Metadata

Assignees

Labels

Projects

Milestone

Relationships

Development

IDLE doc improvements #82006

Description

Activity

terryjreedy commented on Aug 11, 2019

terryjreedy commented on Aug 12, 2019

terryjreedy commented on Aug 12, 2019

terryjreedy commented on Aug 12, 2019

terryjreedy commented on Sep 10, 2019

terryjreedy commented on Jun 26, 2022

terryjreedy commented on Jun 28, 2022

Metadata

Metadata

Assignees

Labels

Projects

Milestone

Relationships

Development

Issue actions