Issue 13439: turtle: Errors in docstrings of onkey and onkeypress (original) (raw)

Created on 2011-11-20 15:15 by smichr, last changed 2022-04-11 14:57 by admin. This issue is now closed.

Messages (8)
msg147995 - (view) Author: Christopher Smith (smichr) Date: 2011-11-20 15:15
The docstring example is written using onkey instead of onkeyrelease.
msg148169 - (view) Author: Petri Lehtinen (petri.lehtinen) * (Python committer) Date: 2011-11-23 06:30
onkey and onkeyrelease are the same function, so you still get exactly the same behavior with the example in the docstring. This also makes it hard to have different docstrings for them. Closing as wontfix.
msg148178 - (view) Author: Christopher Smith (smichr) Date: 2011-11-23 09:49
Sorry for the misdirection: The docstring example for onkeypress is written using onkey instead of onkeypress. (There is no problem for onkey and onkeyrelease.)
msg148203 - (view) Author: Petri Lehtinen (petri.lehtinen) * (Python committer) Date: 2011-11-23 19:58
There are actually many problems with docstrings of both onkey() and onkeypress(). Both: - "Turtle instance named turtle" isn't used in the example - The repl/doctest syntax is weird onkeypress only: - "key-press event" vs. "key-press-event" - The example uses onkey() instead of onkeypress() - The bottom comment says that the example draws a hexagon, but it actually draws a straight line.
msg148205 - (view) Author: Petri Lehtinen (petri.lehtinen) * (Python committer) Date: 2011-11-23 20:01
The problems with onkey() are also there in 2.7. onkeypress() is new in 3.x.
msg148772 - (view) Author: Roundup Robot (python-dev) (Python triager) Date: 2011-12-02 19:28
New changeset 6e03ab9950f6 by Petri Lehtinen in branch '2.7': Issue #13439: Fix many errors in turtle docstrings. http://hg.python.org/cpython/rev/6e03ab9950f6 New changeset cc559e1e3bd8 by Petri Lehtinen in branch '3.2': Issue #13439: Fix many errors in turtle docstrings. http://hg.python.org/cpython/rev/cc559e1e3bd8 New changeset 8d60c1c89105 by Petri Lehtinen in branch 'default': Issue #13439: Merge branch 3.2 http://hg.python.org/cpython/rev/8d60c1c89105
msg148773 - (view) Author: Petri Lehtinen (petri.lehtinen) * (Python committer) Date: 2011-12-02 19:29
Fixed, thanks!
msg148787 - (view) Author: Christopher Smith (smichr) Date: 2011-12-03 08:21
> resolution:  -> fixed > stage: needs patch -> committed/rejected > status: open -> closed > Nice to see a good thing get even better. Thanks for you work. Chris Smith
History
Date User Action Args
2022-04-11 14:57:24 admin set github: 57648
2011-12-03 08:21:36 smichr set messages: +
2011-12-02 19:29:30 petri.lehtinen set status: open -> closedresolution: fixedmessages: + stage: needs patch -> resolved
2011-12-02 19:28:36 python-dev set nosy: + python-devmessages: +
2011-11-23 20:01:49 petri.lehtinen set keywords: + easystage: needs patchmessages: + versions: + Python 2.7
2011-11-23 19:58:43 petri.lehtinen set title: turtle docstring for onkeyrelease references onkey, not onkeyrelease -> turtle: Errors in docstrings of onkey and onkeypressmessages: + stage: resolved -> (no value)
2011-11-23 09:49:14 smichr set status: closed -> openresolution: wont fix -> (no value)messages: +
2011-11-23 06:30:41 petri.lehtinen set status: open -> closedresolution: wont fixassignee: docs@pythonstage: resolvedversions: + Python 3.3nosy: + gregorlingl, docs@pythonmessages: + components: + Documentationtype: behavior
2011-11-23 04:52:08 petri.lehtinen set nosy: + petri.lehtinen
2011-11-20 15:15:23 smichr create