classification
Title: Some functional errors in turtle.py documentation (missing links)
Type: behavior Stage: resolved
Components: Documentation Versions: Python 3.1
process
Status: closed Resolution: fixed
Dependencies: Superseder:
Assigned To: r.david.murray Nosy List: georg.brandl, gregorlingl, loewis, r.david.murray
Priority: normal Keywords:

Created on 2009-06-24 21:24 by gregorlingl, last changed 2009-06-25 14:28 by r.david.murray. This issue is now closed.

Messages (2)
msg89682 - (view) Author: Gregor Lingl (gregorlingl) Date: 2009-06-24 21:24
In the Python3.1rc2 documentation for turtle.py there are the following
functional errors:

In the overview section the (newly added) entries for the functions/methods 

shearfactor
get_shapepoly
onkeypress
numinput

do not have links to the corresponding text sections. These exist but
also have errors, sometimes the leading 'turtle.' is missing, sometimes
the parameter self erroneously appears in the text.

I'm not very educated in restructured Text Syntax respectively the
documentatin system. Nevertheless I inspected the source and I assume
the following causes for this:

In the first lines of the sections for shearfactor and numinput there
are superfluous self, which should be deleted.

In the sections for get_shapepoly, onkeypress and numinput there are
perturbing colons at the end of the first lines, which perhaps should be
deleted.

As I'm not sure if this suggestions are right and/or comlete and I do
not have any means to test them, I cannot submit a patch. 

Please could some docs-guru check my suggestions (and possibly repair
the defects) It would be fine if this errors wouldn't appear in 3.1

Regards,
Gregor
msg89709 - (view) Author: R. David Murray (r.david.murray) * (Python committer) Date: 2009-06-25 14:28
Fixed in r73555.  Thanks.
History
Date User Action Args
2009-06-25 14:28:01r.david.murraysetstatus: open -> closed
type: behavior
messages: + msg89709

resolution: fixed
stage: resolved
2009-06-25 14:21:24r.david.murraysetassignee: georg.brandl -> r.david.murray

nosy: + r.david.murray
2009-06-24 21:24:29gregorlinglcreate