Repository navigation
IDLE documentation for Unix obsolete/incorrect #49316
Description
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 = None
closed_at = <Date 2013-01-14.17:28:16.953>
created_at = <Date 2009-01-26.03:56:57.057>
labels = ['easy', 'expert-IDLE', 'type-bug', 'docs']
title = 'IDLE documentation for Unix obsolete/incorrect'
updated_at = <Date 2013-01-14.17:28:16.951>
user = 'https://github.com/stevendaprano'bugs.python.org fields:
activity = <Date 2013-01-14.17:28:16.951>
actor = 'asvetlov'
assignee = 'docs@python'
closed = True
closed_date = <Date 2013-01-14.17:28:16.953>
closer = 'asvetlov'
components = ['Documentation', 'IDLE']
creation = <Date 2009-01-26.03:56:57.057>
creator = 'steven.daprano'
dependencies = []
files = ['19535', '28138', '28141', '28626', '28643']
hgrepos = []
issue_num = 5066
keywords = ['patch', 'easy']
message_count = 30.0
messages = ['80562', '80595', '81200', '81227', '81268', '86622', '120698', '121743', '176326', '176462', '176463', '176503', '176504', '179033', '179059', '179072', '179266', '179279', '179280', '179312', '179313', '179348', '179359', '179360', '179363', '179406', '179409', '179446', '179957', '179958']
nosy_count = 16.0
nosy_names = ['georg.brandl', 'terry.reedy', 'orsenthil', 'ajaksu2', 'gpolo', 'ezio.melotti', 'roger.serwy', 'eric.araujo', 'steven.daprano', 'asvetlov', 'jesstess', 'docs@python', 'Todd.Rovito', 'ramiroluz', 'python-dev', 'zach.ware']
pr_nums = []
priority = 'normal'
resolution = 'fixed'
stage = 'resolved'
status = 'closed'
superseder = None
type = 'behavior'
url = 'https://bugs.python.org/issue5066'
versions = ['Python 3.4']
Activity
stevendaprano commentedon Jan 26, 2009
Documentation for IDLE states:
http://www.python.org/idle/doc/idlemain.html
I believe that is obsolete, I cannot see a Tools/idle directory in
either 2.5 or 2.6. Perhaps better instructions might be:
or similar.
terryjreedy commentedon Jan 26, 2009
LOL. That doc was apparently last revised in 2000 for the IDLE released
with 1.5.2 (see screenshot). Other needed updates I see are: 'Shell'
and 'Options' have been added to the menu line; we now have unicode
text; screenshots look different (and nicer) on newer Tk on WinXP and
could/should be redone.
If it were decided to update this and add it to the doc package, I would
help in some way.
birkenfeld commentedon Feb 5, 2009
Well, having nice full docs for IDLE would be nice, but I won't do
anything on this matter except committing a full patch :)
terryjreedy commentedon Feb 5, 2009
Is there an HTML to acceptable RST converter?
birkenfeld commentedon Feb 6, 2009
I don't know any. But since rst is so lightweight, it is usually not too
much of a pain to just copy the text from the browser and reintroduce
formatting because you're likely to have to go over and edit the whole
content anyway.
devdanzin commentedon Apr 26, 2009
This looks like a perfect match for GHOP.
jesstess commentedon Nov 8, 2010
Attached is a patch updating the IDLE web documentation as well as the help file displayed when you click the Help -> Idle Help menu item in IDLE. It looks like the IDLE web documentation was lifted directly from the help file at some point and they have gotten out of sync.
The section of the document describing starting IDLE was updated in March of 2009, so I've left that alone. I've updated the Menu option descriptions in both files, including: adding missing items, making the help file and web document descriptions the same, and using a consistent format.
The patch is against release27-maint.
ramiroluz commentedon Nov 20, 2010
I reviewed the texts, applied the patches, ran idle, edited Demo/classes/Dates.py run module inside Idle. Generated the docs inside Doc, with make html and reviewed the IDLE doc in ~/python/py3k/Doc/build/html/library/idle.html?highlight=idle
Only in the 3.2 tree.
9 remaining items
rovitotv commentedon Jan 7, 2013
Zachary,
I like your idea about joining idle.rst with help.txt but I think that should be covered under a separate bug issue. The way I see it this bug is about fixing the current documentation. So I suggest you open up a new issue and get people's take on it. I think a parser could be run at installation to convert idle.rst to help.txt or maybe IDLE could be modified to simply render idle.rst correctly. I am not sure what the best approach will be.
PS Thanks for the review I should have your suggested changes integrating into a new patch today.
zware commentedon Jan 7, 2013
Right you are, Todd; I'll get another issue opened for that soon.
rovitotv commentedon Jan 8, 2013
Zachary,
Thanks for your excellent review!!!! Your feedback was very helpful for making the patch even better.
rovitotv commentedon Jan 8, 2013
Based on Zachary's comments I have uploaded a new version of the patch which is version 3.
merwok commentedon Jan 8, 2013
Idle needs to find its text help files at runtime, so they are installed as data alongside with the code. The rst doc files however can be installed anywhere or not installed at all, so we can’t change Idle to look for them.
An alternate idea to avoid duplication could be to copy the rst file to the code directory at build time.
orsenthil commentedon Jan 8, 2013
Regardless of the topic of merge, the suggested improvements for both idle.rst and help.txt are great! Thanks for working the patch, Todd.
I am +1 with the changes. If no else has any comments, I can go ahead with committing this.
zware commentedon Jan 8, 2013
I'd like to see Éric, Ezio, and my comments on v3 in Rietveld addressed, but after that I'm good with it :)
zware commentedon Jan 8, 2013
bpo-16893 has been filed to deal with the idea of merging the files.
rovitotv commentedon Jan 9, 2013
Thanks Senthil but I don't deserve all the credit this issue is a team effort with lots of help from Zach, Éric, and Ezio. All of which have improved the patch's quality a great deal. Hopefully we can address the issues then let you make the commit soon.
rovitotv commentedon Jan 9, 2013
I took all the comments and created a new patch version 4 which should address all the issues. Thanks for the excellent review and support from everybody. I think this patch is a much higher quality now.
zware commentedon Jan 9, 2013
Version 4 looks good to me!
python-dev commentedon Jan 14, 2013
New changeset d1ef91025d70 by Andrew Svetlov in branch 'default':
Issue bpo-5066: Update IDLE docs
http://hg.python.org/cpython/rev/d1ef91025d70
asvetlov commentedon Jan 14, 2013
Pushed. Thanks.