Changes by Mark Lawrence breamore...@yahoo.co.uk:
--
versions: +Python 3.5 -Python 3.3
___
Python tracker rep...@bugs.python.org
http://bugs.python.org/issue16893
___
___
Changes by Terry J. Reedy tjre...@udel.edu:
--
assignee: docs@python -
versions: +Python 2.7, Python 3.3
___
Python tracker rep...@bugs.python.org
http://bugs.python.org/issue16893
___
Zachary Ware added the comment:
Defaulting to opening a browser window sounds great to me. In those cases
where there is no network access, though, I think we should keep a fallback
help.txt, and I think the Sphinx text rendering is about the simplest and
easiest fallback we can get. Shall
Terry J. Reedy added the comment:
I just discovered that on Windows, the 3rd help option Python Docs - F1 opens
the local doc set whatever.chm in the Windows Help (HTML) Viewer. This is the
same as the start menu choice. So on Windows, opening the same offline copy to
the IDLE page, if
Ned Deily added the comment:
Zach, thanks for addressing most of the comments. The Makefile does now work as
intended and more information is retained in the help.txt.
But I'm still troubled by the plaintext rendering, particularly of the inline
code markup. With the `` marks from the
Terry J. Reedy added the comment:
Great idea. Using a browser to display help text has become pretty common. For
many games, for instance, this has superseded .pdf manuals, which supercedes
paper. Unless there is already a tk extension to display html this seems like a
good idea. We could
Todd Rovito added the comment:
Ned,
Using a web browser is a great idea I like it because it removes code
from IDLE making IDLE even simpler (and better). Besides it would take us
forever to duplicate some of the functionally that exists in today's modern web
browser.
Zach,
Todd Rovito added the comment:
I added roger.serwy to the nosy list. Terry Reedy is already on the list. I
think this issue will help maintain the IDLE documentation now and in the
future. Right now it has to manually be synced between help.txt and idle.rst.
Only Python 3.4 is synced right
Zachary Ware added the comment:
Here's a new version of the patch, with the fixes that Ned pointed out.
I also tried to address concerns about lost information; menu divisions have
been added to Doc/library/idle.rst, along with the blurb about running without
a subprocess being deprecated.
Changes by Zachary Ware zachary.w...@gmail.com:
Removed file: http://bugs.python.org/file28725/issue16893.diff
___
Python tracker rep...@bugs.python.org
http://bugs.python.org/issue16893
___
Zachary Ware added the comment:
Actually, I have an objection myself. In merging this patch with another I'm
working on, I noticed that I failed to include the new 'idledoc' target in the
Makefile usage message. The attached patch fixes that oversight.
--
Added file:
Ned Deily added the comment:
There are a few problems with the proposed patch (v2). I commented on those in
Rietveld. But, beyond that, I'm not convinced that the generated help.txt is
an improvement over the original help.txt. While it is formatted more
consistently (a good thing), it is
Ned Deily added the comment:
For comparison, here's a copy of the new rendered help.txt.
--
Added file: http://bugs.python.org/file29112/help.txt
___
Python tracker rep...@bugs.python.org
http://bugs.python.org/issue16893
Zachary Ware added the comment:
Ping!
If there are no objections, would anyone mind committing this?
--
___
Python tracker rep...@bugs.python.org
http://bugs.python.org/issue16893
___
Zachary Ware added the comment:
Sorry, I wasn't as clear as I meant to be in my last message, I was suddenly
rushed and didn't realize I'd left out what I meant to say, which was:
Now that Andrew has committed Todd's fix to issue 5066, idle.rst and help.txt
are very well-aligned. I believe
Georg Brandl added the comment:
I did test the Makefile change, so this should be good to go. I'll upate PEP
101 once it's in.
--
___
Python tracker rep...@bugs.python.org
http://bugs.python.org/issue16893
___
Zachary Ware added the comment:
Georg:
Note that Sphinx' make text output already should be suitable. We
already update the pydoc topics with that on every release, so we could
just as well do the same for the IDLE doc. No need for another
separate script.
I take it this would mean
Andrew Svetlov added the comment:
Regenerating idle.txt and committing it is fine to me.
--
___
Python tracker rep...@bugs.python.org
http://bugs.python.org/issue16893
___
Georg Brandl added the comment:
I take it this would mean generating help.txt and then checking it in?
Otherwise, users who built their own Python would likely run into issues with
IDLE not finding its help file, or would be required to have sphinx available.
Yes, it will be checked in.
Zachary Ware added the comment:
I don't think we have to worry about it getting out of date quickly.
Fair point :)
Automatically generating the IDLE help at run time from a documentation
source file is not posssible anyway, since the doc sources are not
available in a standard location
Georg Brandl added the comment:
The unified diff is not very helpful; I think somebody has to put the files
side by side and merge.
The pydoc topics are built with a custom Sphinx builder implemented in
tools/sphinxext/pyspecific.py -- but if we just want the vanilla text builder
output it
Georg Brandl added the comment:
To make it actually work, replace library/idle by library/idle.rst.
--
___
Python tracker rep...@bugs.python.org
http://bugs.python.org/issue16893
___
Todd Rovito added the comment:
Andrew,
Zachary and I worked on another issue together to sync idle.rst with
help.txt here:
http://bugs.python.org/issue5066
Issue 5066 is ready for commit if you have time by the way. Thanks!
--
___
Python
Changes by Éric Araujo mer...@netwok.org:
--
nosy: +terry.reedy
___
Python tracker rep...@bugs.python.org
http://bugs.python.org/issue16893
___
___
Python-bugs-list
Andrew Svetlov added the comment:
I like the proposition in general, but files should be synchronized first.
--
nosy: +asvetlov
___
Python tracker rep...@bugs.python.org
http://bugs.python.org/issue16893
___
Georg Brandl added the comment:
Note that Sphinx' make text output already should be suitable. We already
update the pydoc topics with that on every release, so we could just as well do
the same for the IDLE doc. No need for another separate script.
--
nosy: +georg.brandl
Todd Rovito added the comment:
I think getting this issue fixed makes sense, it would save time and remove
duplication.
--
___
Python tracker rep...@bugs.python.org
http://bugs.python.org/issue16893
___
New submission from Zachary Ware:
Lib/idlelib/help.txt and Doc/library/idle.rst contain almost exactly the same
information, only formatted a bit differently. This issue is to suggest the
merger of the two files, by way of creating help.txt from idle.rst as a part of
the build or install
28 matches
Mail list logo
