[docs] IDLE documentation for Unix obsolete/incorrect (issue 5066)

[rovitotv at gmail.com]

Made several comments based on people's inputs in idle.rst.  A version 4
should be added to issue tracker soon.  Thanks!


http://bugs.python.org/review/5066/diff/7039/Doc/library/idle.rst
File Doc/library/idle.rst (right):

http://bugs.python.org/review/5066/diff/7039/Doc/library/idle.rst#newcode21
Doc/library/idle.rst:21: * multi-window text editor with multiple undo,
Python colorizing
On 2013/01/08 14:14:18, eric.araujo wrote:
> Missing comma at end of this line.
Yes I did correct in V4...Thanks!

http://bugs.python.org/review/5066/diff/7039/Doc/library/idle.rst#newcode22
Doc/library/idle.rst:22: smart indent, call tips, and many other
features.
On 2013/01/08 15:45:26, zach.ware wrote:
> Lose the period at the end of this line; it's not a sentence and the
other
> bullet points don't have periods either.
Dang you are right thanks!

http://bugs.python.org/review/5066/diff/7039/Doc/library/idle.rst#newcode213
Doc/library/idle.rst:213: Not complete consider this menu option
experimental.  Run commands in the
On 2013/01/08 08:46:49, ezio.melotti wrote:
> This sentence has some problem.  Maybe "This feature is not complete
and
> considered experimental."?
> (What does "not complete" mean?)
Good question about what does "not complete" mean.  I am only using that
phrase because that is what existed in the documentation before this
patch.  Recently I did test the debugger and it does need some work on
it but that is perhaps another issue.  I do like how you phrased that
sentence and have corrected.

http://bugs.python.org/review/5066/diff/7039/Doc/library/idle.rst#newcode220
Doc/library/idle.rst:220: Toggle automatically opening the stack viewer
on a unhandled exception
On 2013/01/08 15:45:26, zach.ware wrote:
> We can lose the 'a' in 'on a unhandled'.
Corrected in V4

http://bugs.python.org/review/5066/diff/7039/Doc/library/idle.rst#newcode234
Doc/library/idle.rst:234: Code Context (toggle)(only in Editor Window)
On 2013/01/08 15:45:26, zach.ware wrote:
> Here's another '(only in Editor Window)' to become '(Editor window
only)'.
Corrected in V4

http://bugs.python.org/review/5066/diff/7039/Doc/library/idle.rst#newcode322
Doc/library/idle.rst:322: * :kbd:`C-LeftArrow` and :kbd:`C-RightArrow`
moves by words in a strange but
On 2013/01/08 15:45:26, zach.ware wrote:
> I still don't know what 'strange but useful' means. If it's basically
the same
> as the behavior you can get out of MS Notepad with the same
keybindings, we can
> just leave off the 'strange but useful' part.
Removed the "strange but useful" even though I thought the wording was
interesting but you bring up a valid point what does that mean?

http://bugs.python.org/review/5066/diff/7039/Doc/library/idle.rst#newcode329
Doc/library/idle.rst:329: * Some useful :program:`Emacs` bindings are
inherited from Tcl/Tk:
On 2013/01/08 14:14:19, eric.araujo wrote:
> FWIW, the program markup here is wholly useless.
Good catch....I corrected and removed the markup around Emacs in V4.

http://bugs.python.org/review/5066/diff/7039/Doc/library/idle.rst#newcode350
Doc/library/idle.rst:350: Standard Window's bindings (like :kbd:`C-c` to
copy and :kbd:`C-v` to paste)
On 2013/01/08 15:45:26, zach.ware wrote:
> See comment in last review.
Zach wrote in the last review:
"Why the apostrophe in Windows?  And I may be wrong, but aren't these
pretty
standard everywhere these days?  Maybe make it just 'Standard
keybindings
(like...' instead?"

This part of the documentation existed before I got it but you are right
Windows should not have an apostrophe.  IDLE is very strange because you
can actually select which key bindings you want to use so I can use
Window's key bindings on my Mac.  Normally on a Mac copy would be
command-c not control-c.  I like your suggestion so I modified the
wording in V4. My comments from patch 3 might not make sense so you can
ignore those.  Thanks!

http://bugs.python.org/review/5066/diff/7039/Doc/library/idle.rst#newcode360
Doc/library/idle.rst:360: to 4 spaces if they are there. :kbd:`tab`
inserts spaces (in the Python
On 2013/01/08 08:46:49, ezio.melotti wrote:
> The other keys use capital letters, why this has been changed to
lowercase?
Yes you are correct...thanks!

http://bugs.python.org/review/5066/diff/7039/Doc/library/idle.rst#newcode361
Doc/library/idle.rst:361: Shell window one tab), number depends on
Indent width. (N.B. Currently tabs
On 2013/01/08 14:14:19, eric.araujo wrote:
> I don’t know if the abbreviation “NB” exists in English.  Anyhow,
saying “Note:
> X” or “Note that X” is often not really helpful: we can just write
“X”.
Thanks Eric!!! I was wondering what the heck NB meant....

http://bugs.python.org/review/5066/diff/7039/Doc/library/idle.rst#newcode395
Doc/library/idle.rst:395: 'Hidden' attributes can be accessed by typing
the beginning of hidden
On 2013/01/08 08:46:49, ezio.melotti wrote:
> This should probably be "Hidden".
Corrected in V4.

http://bugs.python.org/review/5066/diff/7039/Doc/library/idle.rst#newcode396
Doc/library/idle.rst:396: name after a '.'. e.g. '_'. This allows access
to modules with
On 2013/01/08 08:46:49, ezio.melotti wrote:
> '.',
Excellent catch....corrected!

http://bugs.python.org/review/5066/diff/7039/Doc/library/idle.rst#newcode397
Doc/library/idle.rst:397: '__all__' set, or to class-private attributes.
On 2013/01/08 08:46:49, ezio.melotti wrote:
> ``__all__``
Ok I corrected in V4.

http://bugs.python.org/review/5066/diff/7039/Doc/library/idle.rst#newcode402
Doc/library/idle.rst:402: an Editor window which are not via __main__ or
sys.modules will not be
On 2013/01/08 08:46:49, ezio.melotti wrote:
> ``__main__`` and :data:`sys.modules`
Ok I corrected in V4.

http://bugs.python.org/review/5066/diff/7039/Doc/library/idle.rst#newcode516
Doc/library/idle.rst:516: available at docs.python.org.  Selected URLs
can be added or removed from
On 2013/01/08 14:14:19, eric.araujo wrote:
> I don’t really understand the first sentence.  Readers already know
that they
> can access the Python doc, because they are reading a page from these
docs. 
> Maybe by “access” you mean that there is a menu entry in IDLE that
opens the
> docs?  If so, I think you could start by saying that.
Ok I tried to correct as you suggested in version 4.  Thanks.

http://bugs.python.org/review/5066/