Replace Idle's README.txt with annotated file list

[terryjreedy]

BPO	25224
Nosy	@terryjreedy, @roseman
Files	@readme.diff: Draft replacement for current readme README2.diff

^{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 = <Date 2017-06-23.04:41:57.021>
created_at = <Date 2015-09-23.21:56:49.445>
labels = ['expert-IDLE', 'type-feature']
title = "Replace Idle's README.txt with annotated file list"
updated_at = <Date 2017-06-23.04:41:57.019>
user = 'https://github.com/terryjreedy'

bugs.python.org fields:

activity = <Date 2017-06-23.04:41:57.019>
actor = 'terry.reedy'
assignee = 'terry.reedy'
closed = True
closed_date = <Date 2017-06-23.04:41:57.021>
closer = 'terry.reedy'
components = ['IDLE']
creation = <Date 2015-09-23.21:56:49.445>
creator = 'terry.reedy'
dependencies = []
files = ['40624', '40629']
hgrepos = []
issue_num = 25224
keywords = ['patch']
message_count = 5.0
messages = ['251464', '251470', '251913', '251943', '252188']
nosy_count = 3.0
nosy_names = ['terry.reedy', 'markroseman', 'python-dev']
pr_nums = []
priority = 'normal'
resolution = 'fixed'
stage = 'resolved'
status = 'closed'
superseder = None
type = 'enhancement'
url = 'https://bugs.python.org/issue25224'
versions = ['Python 2.7', 'Python 3.4', 'Python 3.5', 'Python 3.6']

[terryjreedy]

idlelib currently has user information that belongs in either the Idle reference idle.rst or possibly a separate Idle howto bpo-17583. This information should be removed and replaced with an annotated list of files in idlelib. The latter would help people working of Idle, and even people just browsing.

[python-dev]

New changeset 5a60fdd9af8c by Terry Jan Reedy in branch '2.7':
bpo-25224: Augment Idle doc feature list and no-subprocess section
https://hg.python.org/cpython/rev/5a60fdd9af8c

New changeset 0f20f3fe7ab4 by Terry Jan Reedy in branch '3.4':
bpo-25224: Augment Idle doc feature list and no-subprocess section
https://hg.python.org/cpython/rev/0f20f3fe7ab4

New changeset b5c8a40d4240 by Terry Jan Reedy in branch '2.7':
bpo-25224: Augment Idle doc feature list and no-subprocess section
https://hg.python.org/cpython/rev/b5c8a40d4240

[terryjreedy]

I believe the previous patch finishes making the current README.txt obsolete and ready to be replaced. Attached for review and comment is a mostly complete annotated listing of idlelib files and Idle menu items. I intend to apply this or a revised version by Friday. I consider this important for keeping track of the changes we make.

[roseman]

Good start... would have been very helpful for me a couple of months back!

Have attached a patch to your patch, breaking the main implementation into a few categories, and fixing a few typos.

[python-dev]

New changeset 4e62989e3688 by Terry Jan Reedy in branch '2.7':
Issue bpo-25224: README.txt is now an idlelib index for IDLE developers and
https://hg.python.org/cpython/rev/4e62989e3688

New changeset bb1a8d3dd4a1 by Terry Jan Reedy in branch '3.4':
Issue bpo-25224: README.txt is now an idlelib index for IDLE developers and
https://hg.python.org/cpython/rev/bb1a8d3dd4a1