Mailman 3 October 2010 - docs

[issue7061] Improve 24.5. turtle doc
by Terry J. Reedy Oct. 30, 2010

Oct. 30, 2010

Terry J. Reedy <tjreedy(a)udel.edu> 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 corresponding functions* should explicitly give the needed code. So I would change "Most of the examples in this section refer to a Turtle instance called turtle." to "The examples below that refer to a Turtle instance called turtle require something like the following to be run first: >>> from turtle import turtle; turtle = Turtle() " The three examples above turtle.shapetransform start with >>> turtle.reset() I presume they need that to run reliably. If it is also needed for the shapetransform example to run correctly, then I would just added it there too. I will post more after I compare my original post to your revision. ---------- _______________________________________ Python tracker <report(a)bugs.python.org> <http://bugs.python.org/issue7061> _______________________________________

1 0

[issue10244] PEP100 has broken links
by Maciej Fijalkowski Oct. 30, 2010

Oct. 30, 2010

New submission from Maciej Fijalkowski <fijall(a)gmail.com>: PEP100 (http://www.python.org/dev/peps/pep-0100/) links to python starship. Should it just link to python.org for the newest version of this doc? ---------- assignee: docs@python components: Documentation messages: 119967 nosy: docs@python, fijall priority: normal severity: normal status: open title: PEP100 has broken links _______________________________________ Python tracker <report(a)bugs.python.org> <http://bugs.python.org/issue10244> _______________________________________

4 6

[issue10224] Build 3.x documentation using python3.x
by Zbyszek Szmek Oct. 30, 2010

Oct. 30, 2010

Changes by Zbyszek Szmek <zbyszek(a)in.waw.pl>: ---------- nosy: +zbysz _______________________________________ Python tracker <report(a)bugs.python.org> <http://bugs.python.org/issue10224> _______________________________________

1 0

[issue7061] Improve 24.5. turtle doc
by Alexander Belopolsky Oct. 29, 2010

Oct. 29, 2010

Alexander Belopolsky <belopolsky(a)users.sourceforge.net> 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.shapesize(4,2) >>> turtle.shearfactor(-0.5) >>> turtle.shapetransform() (4.0, -1.0, -0.0, 2.0) but I don't think it is a good idea to pollute the documentation this way. ---------- _______________________________________ Python tracker <report(a)bugs.python.org> <http://bugs.python.org/issue7061> _______________________________________

1 0

[issue7061] Improve 24.5. turtle doc
by Alexander Belopolsky Oct. 29, 2010

Oct. 29, 2010

Alexander Belopolsky <belopolsky(a)users.sourceforge.net> 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 <report(a)bugs.python.org> <http://bugs.python.org/issue7061> _______________________________________

1 0

[issue7061] Improve 24.5. turtle doc
by Alexander Belopolsky Oct. 29, 2010

Oct. 29, 2010

Alexander Belopolsky <belopolsky(a)users.sourceforge.net> 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 remaining failures that I attribute to sphinx bugs. One is due to an already reported ellipsis bug, and the other is a rather strange failure in the shapetransform example. Georg, can you take a look? File "library/turtle.rst", line 1272, in default Failed example: turtle.shapetransform() Expected: (4.0, -1.0, -0.0, 2.0) Got: (2.82842712474619, -2.121320343559643, 2.8284271247461907, 0.7071067811865472) Note that this test succeeds when it is the only test in a file. ---------- Added file: http://bugs.python.org/file19418/issue7061b.diff _______________________________________ Python tracker <report(a)bugs.python.org> <http://bugs.python.org/issue7061> _______________________________________

1 0

[issue7061] Improve 24.5. turtle doc
by Alexander Belopolsky Oct. 29, 2010

Oct. 29, 2010

Alexander Belopolsky <belopolsky(a)users.sourceforge.net> added the comment: Committed issue7061a.diff r85930. This is probably a backport candidate. ---------- _______________________________________ Python tracker <report(a)bugs.python.org> <http://bugs.python.org/issue7061> _______________________________________

1 0

[issue10224] Build 3.x documentation using python3.x
by Daniel Urban Oct. 29, 2010

Oct. 29, 2010

Changes by Daniel Urban <urban.dani+py(a)gmail.com>: ---------- nosy: +durban _______________________________________ Python tracker <report(a)bugs.python.org> <http://bugs.python.org/issue10224> _______________________________________

1 0

[issue10225] Fix doctest runable examples in python manual
by Alexander Belopolsky Oct. 29, 2010

Oct. 29, 2010

Alexander Belopolsky <belopolsky(a)users.sourceforge.net> added the comment: I started porting the patch to 3.x and it looks like I've uncovered another bug in sphinx: $ sphinx-build -b doctest -d build/doctrees . build/doctest library/traceback.rst .. ********************************************************************** File "library/traceback.rst", line 327, in default .. Differences (ndiff with -expected +actual): *** print_tb: - File "<doctest...>", line 10, in <module> ? ^^^ + File "<doctest default[0]>", line 10, in <module> ? ^^^^^^^^^^^ lumberjack() (I added +REPORT_NDIFF to testoutput options for clarity.) I even tried adding +ELLIPSIS to options, but this did not help. The same example works in 2.7. ---------- _______________________________________ Python tracker <report(a)bugs.python.org> <http://bugs.python.org/issue10225> _______________________________________

1 0

[issue10224] Build 3.x documentation using python3.x
by Alexander Belopolsky Oct. 29, 2010

Oct. 29, 2010

Alexander Belopolsky <belopolsky(a)users.sourceforge.net> added the comment: > The usual build process via Makefile still uses Python 2, > and that won't change for 3.2. Would you consider changing "doctest" make target to check out sphinx trunk (or 3.x compatible release) and run it with the py3k python? This should not affect regular doc builds and running doctest under anything other than the current version of python makes very little sense. Note that I am still targeting documentation fixes for 3.2. See issue 10225. ---------- _______________________________________ Python tracker <report(a)bugs.python.org> <http://bugs.python.org/issue10224> _______________________________________

1 0