Skip to content

Add idlelib module entry to doc #75510

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

Closed
terryjreedy opened this issue Sep 1, 2017 · 7 comments
Closed

Add idlelib module entry to doc #75510

terryjreedy opened this issue Sep 1, 2017 · 7 comments
Assignees
Labels
docs Documentation in the Doc dir topic-IDLE type-feature A feature request or enhancement

Comments

@terryjreedy
Copy link
Member

BPO 31329
Nosy @rhettinger, @terryjreedy

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 2017-09-01.19:24:07.937>
labels = ['3.8', 'expert-IDLE', 'type-feature', '3.7']
title = 'Add idlelib module entry to doc'
updated_at = <Date 2020-10-08.00:07:34.577>
user = 'https://github.com/terryjreedy'

bugs.python.org fields:

activity = <Date 2020-10-08.00:07:34.577>
actor = 'terry.reedy'
assignee = 'terry.reedy'
closed = False
closed_date = None
closer = None
components = ['IDLE']
creation = <Date 2017-09-01.19:24:07.937>
creator = 'terry.reedy'
dependencies = []
files = []
hgrepos = []
issue_num = 31329
keywords = []
message_count = 5.0
messages = ['301145', '301153', '301171', '338497', '378203']
nosy_count = 2.0
nosy_names = ['rhettinger', 'terry.reedy']
pr_nums = []
priority = 'normal'
resolution = None
stage = 'needs patch'
status = 'open'
superseder = None
type = 'enhancement'
url = 'https://bugs.python.org/issue31329'
versions = ['Python 3.7', 'Python 3.8']

@terryjreedy
Copy link
Member Author

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

@terryjreedy terryjreedy added 3.7 (EOL) end of life type-feature A feature request or enhancement labels Sep 1, 2017
@rhettinger
Copy link
Contributor

rhettinger commented Sep 1, 2017

See also #75500.

A cleaner command-line startup would be: python -m idle

@terryjreedy
Copy link
Member Author

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

@terryjreedy terryjreedy self-assigned this Mar 20, 2019
@terryjreedy
Copy link
Member Author

terryjreedy commented Mar 20, 2019

See also #59149 (comment). The issue is otherwise about the Using doc.

@terryjreedy
Copy link
Member Author

terryjreedy commented Oct 8, 2020

I closed #86134 as a duplicate of this.

@terryjreedy
Copy link
Member Author

Leaving open for the IDLE start doc comments.

terryjreedy added a commit to terryjreedy/cpython that referenced this issue Aug 11, 2022
Make section instead of subsection and revise sentence.
terryjreedy added a commit that referenced this issue Aug 11, 2022
Make section instead of subsection and revise sentence.
miss-islington pushed a commit to miss-islington/cpython that referenced this issue Aug 11, 2022
Make section instead of subsection and revise sentence.
(cherry picked from commit 9af4aed)

Co-authored-by: Terry Jan Reedy <tjreedy@udel.edu>
miss-islington pushed a commit to miss-islington/cpython that referenced this issue Aug 11, 2022
Make section instead of subsection and revise sentence.
(cherry picked from commit 9af4aed)

Co-authored-by: Terry Jan Reedy <tjreedy@udel.edu>
miss-islington added a commit that referenced this issue Aug 11, 2022
Make section instead of subsection and revise sentence.
(cherry picked from commit 9af4aed)

Co-authored-by: Terry Jan Reedy <tjreedy@udel.edu>
miss-islington added a commit that referenced this issue Aug 11, 2022
Make section instead of subsection and revise sentence.
(cherry picked from commit 9af4aed)

Co-authored-by: Terry Jan Reedy <tjreedy@udel.edu>
@terryjreedy
Copy link
Member Author

idlelib/help.html was updated to match by #96523 and backports

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
docs Documentation in the Doc dir topic-IDLE type-feature A feature request or enhancement
Projects
Status: Done
Development

No branches or pull requests

3 participants