Navigation Menu

Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

IDLE doc improvements #82006

Closed
terryjreedy opened this issue Aug 11, 2019 · 7 comments
Closed

IDLE doc improvements #82006

terryjreedy opened this issue Aug 11, 2019 · 7 comments
Assignees
@terryjreedy
Labels
3.12 bugs and security fixes topic-IDLE

Comments

@terryjreedy
Copy link
Member

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']
@terryjreedy
Copy link
Member Author

  1. Headings: Sections should be titlecased, subsections not. This is especially needed now that they are not numbered.

  2. Python Shell subsection. Revise 'paste', maybe move. SyntaxWarnings are SyntaxErrors. Explain Restart.

  3. Any other pending changes I include.

@terryjreedy terryjreedy added 3.7 (EOL) end of life 3.8 only security fixes 3.9 only security fixes labels Aug 11, 2019
@terryjreedy terryjreedy self-assigned this Aug 11, 2019
@terryjreedy
Copy link
Member Author

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.

@terryjreedy
Copy link
Member Author

  1. 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.

@terryjreedy
Copy link
Member Author

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

@terryjreedy
Copy link
Member Author

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 ...'

@ezio-melotti ezio-melotti transferred this issue from another repository Apr 10, 2022
@terryjreedy terryjreedy added 3.12 bugs and security fixes and removed 3.9 only security fixes 3.8 only security fixes 3.7 (EOL) end of life labels Jun 26, 2022
@terryjreedy
Copy link
Member Author

terryjreedy commented Jun 26, 2022 •
edited

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.

terryjreedy added a commit to terryjreedy/cpython that referenced this issue Jun 27, 2022
@terryjreedy
pythongh-82006: IDLE doc improvements
009bde1 
1. Title-case sections but not subsections.
2. Edit Shell Window sections: title, execute, restart
@bedevere-bot bedevere-bot mentioned this issue Jun 27, 2022
Merged
terryjreedy added a commit that referenced this issue Jun 27, 2022
@terryjreedy
gh-82006: IDLE doc improvements (#94349)
e6391e0 
0. Update text start and stop conditions.
1. Title-case sections but not subsections.
2. Edit Shell Window sections: title, execute, restart.
miss-islington pushed a commit to miss-islington/cpython that referenced this issue Jun 27, 2022
@terryjreedy @miss-islington
pythongh-82006: IDLE doc improvements (pythonGH-94349)
4b0c66c 
0. Update text start and stop conditions.
1. Title-case sections but not subsections.
2. Edit Shell Window sections: title, execute, restart.
(cherry picked from commit e6391e0)

Co-authored-by: Terry Jan Reedy <tjreedy@udel.edu>
This was referenced Jun 27, 2022
Merged
Merged
miss-islington pushed a commit to miss-islington/cpython that referenced this issue Jun 27, 2022
@terryjreedy @miss-islington
pythongh-82006: IDLE doc improvements (pythonGH-94349)
559776f 
0. Update text start and stop conditions.
1. Title-case sections but not subsections.
2. Edit Shell Window sections: title, execute, restart.
(cherry picked from commit e6391e0)

Co-authored-by: Terry Jan Reedy <tjreedy@udel.edu>
miss-islington added a commit that referenced this issue Jun 27, 2022
@miss-islington @terryjreedy
gh-82006: IDLE doc improvements (GH-94349)
1d2c8ff 
0. Update text start and stop conditions.
1. Title-case sections but not subsections.
2. Edit Shell Window sections: title, execute, restart.
(cherry picked from commit e6391e0)

Co-authored-by: Terry Jan Reedy <tjreedy@udel.edu>
ambv added a commit that referenced this issue Jun 28, 2022
@miss-islington @terryjreedy @ambv
[3.10] gh-82006: IDLE doc improvements (GH-94349) (GH-94358)
eb7d354 
0. Update text start and stop conditions.
1. Title-case sections but not subsections.
2. Edit Shell Window sections: title, execute, restart.
(cherry picked from commit e6391e0)

Co-authored-by: Terry Jan Reedy <tjreedy@udel.edu>
Co-authored-by: Łukasz Langa <lukasz@langa.pl>
@terryjreedy
Copy link
Member Author

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

gvanrossum pushed a commit to gvanrossum/cpython that referenced this issue Jun 30, 2022
@terryjreedy @gvanrossum
pythongh-82006: IDLE doc improvements (python#94349)
41302b0 
0. Update text start and stop conditions.
1. Title-case sections but not subsections.
2. Edit Shell Window sections: title, execute, restart.
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees

@terryjreedy terryjreedy

Labels
3.12 bugs and security fixes topic-IDLE
Projects
None yet
Milestone
No milestone
Development

No branches or pull requests
1 participant
@terryjreedy