[issue7061] Improve turtle module documentation

[R. David Murray]

R. David Murray added the comment:

If there *is* anything left to do here, new issues should be opened.

--
nosy: +r.david.murray
resolution: accepted -> fixed
stage: commit review -> resolved
status: open -> closed

___
Python tracker 

___
___
Python-bugs-list mailing list
Unsubscribe: 
https://mail.python.org/mailman/options/python-bugs-list/archive%40mail-archive.com

[issue7061] Improve turtle module documentation

[A.M. Kuchling]

A.M. Kuchling added the comment:

Is there anything left to do for this issue?

--
nosy: +akuchling

___
Python tracker 

___
___
Python-bugs-list mailing list
Unsubscribe: 
https://mail.python.org/mailman/options/python-bugs-list/archive%40mail-archive.com

[issue7061] Improve turtle module documentation

[Alexander Belopolsky]

Alexander Belopolsky  added the comment:

On Sun, Oct 31, 2010 at 8:00 PM, Éric Araujo  wrote:
..
> “Python” is lower-cased only when referring to the executable (as a 
> file) itself.  When talking about the language, the implementation or
> the VM in an abstract way (not a file), It think it’s always “Python”.

For the record, this is covered in the Python documentation style guide:

"""
Python

The name of our favorite programming language is always capitalized.
"""

http://docs.python.org/dev/documenting/style.html

--

___
Python tracker 

___
___
Python-bugs-list mailing list
Unsubscribe: 
http://mail.python.org/mailman/options/python-bugs-list/archive%40mail-archive.com

[issue7061] Improve turtle module documentation

[Alexander Belopolsky]

Alexander Belopolsky  added the comment:

Committed a slightly modified turtle-star-sidebar.diff in revision 86364.  Note 
that I've included both pdf and postscript files in case someone would want to 
run postscript through a better distiller than the OSX preview that I used.  
The postscript was produced using postscript() method of the tkinter canvas and 
bbox was manually adjusted.

--

___
Python tracker 

___
___
Python-bugs-list mailing list
Unsubscribe: 
http://mail.python.org/mailman/options/python-bugs-list/archive%40mail-archive.com

[issue7061] Improve turtle module documentation

[Terry J. Reedy]

Terry J. Reedy  added the comment:

To me, the mini change logs are both distracting noise and contrary to the 
general start-fresh policy for 3.x docs, stated somewhere by Georg B, which I 
really like.

--

___
Python tracker 

___
___
Python-bugs-list mailing list
Unsubscribe: 
http://mail.python.org/mailman/options/python-bugs-list/archive%40mail-archive.com

[issue7061] Improve turtle module documentation

[Alexander Belopolsky]

Alexander Belopolsky  added the comment:

On Tue, Nov 9, 2010 at 11:45 AM, Raymond Hettinger
 wrote:
..
> Raymond Hettinger  added the comment:
>
> The mini change log is harmless.  I would leave it as is.

It is not entirely harmless.  First, it occupies valuable easy to
scroll to end-of-page real estate which is better used for the "Demo
scripts" section.  Second, "Changes since 3.0" in 3.2 documentation
without  "Changes since 3.1" give a feel of unmaintained module.
Third, "Changes since 3.0" refers to the Demo directory which no
longer exists and I don't want to add "Changes since 3.1" to fix that.
 However, I don't feel too strongly about removing them.  I would
leave this for the "What's new" editor to decide and if that's
Raymond, I guess the decision has been made.

--

___
Python tracker 

___
___
Python-bugs-list mailing list
Unsubscribe: 
http://mail.python.org/mailman/options/python-bugs-list/archive%40mail-archive.com

[issue7061] Improve turtle module documentation

[Raymond Hettinger]

Raymond Hettinger  added the comment:

The mini change log is harmless.  I would leave it as is.

--

___
Python tracker 

___
___
Python-bugs-list mailing list
Unsubscribe: 
http://mail.python.org/mailman/options/python-bugs-list/archive%40mail-archive.com

[issue7061] Improve turtle module documentation

[Alexander Belopolsky]

Alexander Belopolsky  added the comment:

On Sat, Oct 30, 2010 at 8:27 PM, Terry J. Reedy  wrote:
..
> Sections about 2.x changes should not be in 3.x docs.

I agree.  Neither "Changes since Python 2.6" nor "Changes since Python 2.6" 
belong in this section.  The first belongs to "What's new in Python 2.7" and 
the second to "What's new in Python 3.1".  Do we edit these files 
retroactively?  I don't want to simply remove these sections.  Raymond, can you 
advise?

On a similar note, I don't think the introduction section should refer to "the 
old turtle module".

--

___
Python tracker 

___
___
Python-bugs-list mailing list
Unsubscribe: 
http://mail.python.org/mailman/options/python-bugs-list/archive%40mail-archive.com

[issue7061] Improve turtle module documentation

[Terry J. Reedy]

Terry J. Reedy  added the comment:

I like it!

--

___
Python tracker 

___
___
Python-bugs-list mailing list
Unsubscribe: 
http://mail.python.org/mailman/options/python-bugs-list/archive%40mail-archive.com

[issue7061] Improve turtle module documentation

[Alexander Belopolsky]

Alexander Belopolsky  added the comment:

As a follow-up to Raymond's suggestion, I am attaching a patch that will add a 
sidebar to the introduction section of the turtle documentation section.  While 
it is not common to include screenshots in python documentation, I think it is 
very appropriate for a visual module such as turtle.  I considered a "Basic 
example" subsection similar to that in unittest module documentation, but 
turtle introduction already has a basic example (forward(15); left(25) embedded 
in the prose, so I think a sidebar like this is more appropriate. 

Since svn does not include binary files in the patch, I will have to attach the 
embedded image separately.  I will also post a screenshot of the rendered HTML 
page.

--
Added file: http://bugs.python.org/file19557/turtle-star-sidebar.diff

___
Python tracker 

___
___
Python-bugs-list mailing list
Unsubscribe: 
http://mail.python.org/mailman/options/python-bugs-list/archive%40mail-archive.com

[issue7061] Improve turtle module documentation

[Alexander Belopolsky]

Changes by Alexander Belopolsky :


Added file: http://bugs.python.org/file19558/turtle-star.png

___
Python tracker 

___
___
Python-bugs-list mailing list
Unsubscribe: 
http://mail.python.org/mailman/options/python-bugs-list/archive%40mail-archive.com

[issue7061] Improve turtle module documentation

[Alexander Belopolsky]

Changes by Alexander Belopolsky :


Added file: http://bugs.python.org/file19559/turtle-sidebar-screenshot.png

___
Python tracker 

___
___
Python-bugs-list mailing list
Unsubscribe: 
http://mail.python.org/mailman/options/python-bugs-list/archive%40mail-archive.com

[issue7061] Improve turtle module documentation

[Alexander Belopolsky]

Changes by Alexander Belopolsky :


--
title: Improve 24.5. turtle doc -> Improve turtle module documentation

___
Python tracker 

___
___
Python-bugs-list mailing list
Unsubscribe: 
http://mail.python.org/mailman/options/python-bugs-list/archive%40mail-archive.com