[issue7061] Improve 24.5. turtle doc

Alexander Belopolsky added the comment: >From IRC (raymondh): in the turtle docs, can you add a quick start guide (like we have in the unittest docs) the turtle docs have grown into a small book and is intimidating to get started with. -- nosy: +rhettinger __

[issue7061] Improve 24.5. turtle doc

Gregor Lingl added the comment: What do you mean with "similar approach"? Keep in mind, that functions derived form turtle methods, call methods for the class variable _pen of class Turtle. A new Turtle-object is bound to _pen, if it is not already present, whenever one of these functions is ca

[issue7061] Improve 24.5. turtle doc

Alexander Belopolsky added the comment: On Fri, Nov 5, 2010 at 3:34 AM, Georg Brandl wrote: .. > Why shouldn't global function doctests be runnable? They should - I just couldn't figure out a better hack that would work for both mathods and functions. Note that functions are auto-generated in

[issue7061] Improve 24.5. turtle doc

Georg Brandl added the comment: Why shouldn't global function doctests be runnable? -- ___ Python tracker ___ ___ Python-bugs-list mai

[issue7061] Improve 24.5. turtle doc

Alexander Belopolsky added the comment: I am attaching a patch that adds a hack that allows to run turtle doctests using turtle.run_doctests() function. Running this function has revealed numerous mistakes in doctests that are corrected in the patch. The patch is against release27 branch bec

[issue7061] Improve 24.5. turtle doc

Éric Araujo added the comment: “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”. -- ___ P

[issue7061] Improve 24.5. turtle doc

Alexander Belopolsky added the comment: On Sat, Oct 30, 2010 at 8:27 PM, Terry J. Reedy wrote: .. > "version of python installed with Tk support.": cap 'python' to 'Python' > > Is there any standard on capitalizing 'Python'? It looks like it is consistently capitalized in the Python manual. >

[issue7061] Improve 24.5. turtle doc

Terry J. Reedy added the comment: GREGOR, I think we need your help to answer a few of these. Subissues from my opening post not resolved in rev85732 "version of python installed with Tk support.": cap 'python' to 'Python' Is there any standard on capitalizing 'Python'? -

[issue7061] Improve 24.5. turtle doc

Terry J. Reedy added the comment: On initialization: the json doc has 6 examples. Each starts with 'import json' so each is independent. However, I agree that doing the same for turtle examples would be a bit much. On the other hand, I think 24.5.3. *Methods of RawTurtle/Turtle and correspondi

[issue7061] Improve 24.5. turtle doc

Alexander Belopolsky added the comment: As I suspected, the turtle.shapetransform() stems from sphinx' failure to reinitialize the turtle variable as testsetup dictates. I can work around this by adding >>> turtle = Turtle() above >>> turtle.shape("square") >>> turtle.sh

[issue7061] Improve 24.5. turtle doc

Alexander Belopolsky added the comment: Gregor, I suspect that there are doctest mistakes in the turtle.py docstrings, but I cannot figure out how to run it through doctest. Can you help? -- ___ Python tracker _

[issue7061] Improve 24.5. turtle doc

Alexander Belopolsky added the comment: While working on issue 10225, I have found several mistakes in turtle.rst examples. It probably makes sense to review these separately and commit as part of this issue rather than bunching with the other issue 10225 changes. There are still two remaini

[issue7061] Improve 24.5. turtle doc

Alexander Belopolsky added the comment: Committed issue7061a.diff r85930. This is probably a backport candidate. -- ___ Python tracker ___ __

[issue7061] Improve 24.5. turtle doc

Changes by Alexander Belopolsky : -- stage: committed/rejected -> commit review ___ Python tracker ___ ___ Python-bugs-list mailing lis

[issue7061] Improve 24.5. turtle doc

Alexander Belopolsky added the comment: Attaching another small doc improvement: "gon" is better know as "grad" and even under that name requires an explanation. See issue7061a.diff -- Added file: http://bugs.python.org/file19404/issue7061a.diff ___

[issue7061] Improve 24.5. turtle doc

Georg Brandl added the comment: If you do a full build, you'll get a warning; however, currently documents that reference a label will not be recognized as out of date when that label changes or is removed. -- status: pending -> open ___ Python tra

[issue7061] Improve 24.5. turtle doc

Alexander Belopolsky added the comment: Committed in revision 85853. Terry, please chime in if I missed anything that you would consider part of this issue. Note that the speed vs. delay may not be just a doc issue. I opened issue 10170 for that. -- resolution: -> accepted stage:

[issue7061] Improve 24.5. turtle doc

Alexander Belopolsky added the comment: On Tue, Oct 26, 2010 at 3:32 PM, Georg Brandl wrote: .. > LGTM, if you verified that the label "debugger" is not in use at the moment. Good point. I naively hoped that Sphinx would warn me about a reference to an undefined label. Grep found a reference

[issue7061] Improve 24.5. turtle doc

Georg Brandl added the comment: LGTM, if you verified that the label "debugger" is not in use at the moment. -- ___ Python tracker ___ ___

[issue7061] Improve 24.5. turtle doc

Éric Araujo added the comment: Looks good. Remember to adjust the number of signs making the reST title markup. Nice that you’re fixing the ToC; I noticed a handful of issues some days ago and thought about making a patch in a week or two. I’d open another report for them and backport the

[issue7061] Improve 24.5. turtle doc

Alexander Belopolsky added the comment: Attached patch, issue7061.diff, drops "for Tk" from turtle module title and move its doc section under frameworks. I also fixed a couple of markup issues that affected TOC rendering. -- keywords: +patch stage: -> commit review Added file: http

[issue7061] Improve 24.5. turtle doc

Éric Araujo added the comment: Agreed that Program Frameworks is the most adequate section. For the backport, I don’t see that turtle should have different rules than other modules, but I’m not firmly attached to this, so do as you wish. -- ___ Pyt

[issue7061] Improve 24.5. turtle doc

Alexander Belopolsky added the comment: On Thu, Oct 21, 2010 at 3:00 PM, Éric Araujo wrote: .. > +1. [remove reference to Tk from title] > If we do that, I think we should move turtle documentation out of the "Graphical User Interfaces with Tk" chapter. It would be more appropriate to place it

[issue7061] Improve 24.5. turtle doc

Éric Araujo added the comment: +1. BTW, aren’t the fixes relevant for 2.7 too? -- ___ Python tracker ___ ___ Python-bugs-list mailing

[issue7061] Improve 24.5. turtle doc

Alexander Belopolsky added the comment: I also wonder if the title should be changed from "Turtle graphics for Tk" to simply "Turtle graphics". As explained in issue3884, msg73465 turtle's use of Tk is an implementation detail and the title may be confusing to the target audience. Presumabl

[issue7061] Improve 24.5. turtle doc

Alexander Belopolsky added the comment: On Thu, Oct 21, 2010 at 2:12 PM, Alexander Belopolsky wrote: > The hyphen fix, however seems easier to commit than to > remember.   I'll do it now. > Committed in r85778. -- ___ Python tracker

[issue7061] Improve 24.5. turtle doc

Alexander Belopolsky added the comment: On Thu, Oct 21, 2010 at 2:03 PM, Éric Araujo wrote: .. > Having more hyphens than title characters is not an error for reST, but it’s > not done in the rest of the document. >  I suggest “fixing” that when you do further changes in the file (it’s not >

[issue7061] Improve 24.5. turtle doc

Éric Araujo added the comment: >From your commit: -Excursus about the use of compound shapes +Compound shapes - Having more hyphens than title characters is not an error for reST, but it’s not done in the rest of the document. I suggest “fixing” that w

[issue7061] Improve 24.5. turtle doc

Alexander Belopolsky added the comment: Committed some of the simpler fixes in r85732. > ?? Unclear how [delay()] interacts with turtle.speed Unclear indeed. See issue 3062. -- ___ Python tracker __

[issue7061] Improve 24.5. turtle doc

Alexander Belopolsky added the comment: > It seems that 'add=False' would be same as 'add=None' and more > consistent with below. The add argument is passed unchanged to canvas' bind method which is documented as taking either '' or '+' string: http://docs.python.org/library/tkinter.html?high

[issue7061] Improve 24.5. turtle doc

Gregor Lingl added the comment: Thanks, Terry, for reading the docs that thoroughly. Alas, for the next week I'm too busy (with preparing "Python für Kids" for press) to work through this long list. Since it doesn't seem to be *very* urgent, I'll defer that work until Oct. 12th or so. Then I'll

[issue7061] Improve 24.5. turtle doc

New submission from Terry J. Reedy : Reading through 24.5 on the turtle module, I have a number of comments aimed at improvements. Some are straightforward fixes which any doc maintainer could enter. Others are questions about meaning that I presume the current maintainer, gregor lingl may have t