[New-bugs-announce] [issue6339] Some functional errors in turtle.py documentation (missing links)

Gregor Lingl report at bugs.python.org
Wed Jun 24 23:24:30 CEST 2009


New submission from Gregor Lingl <gregorlingl at users.sourceforge.net>:

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

----------
assignee: georg.brandl
components: Documentation
messages: 89682
nosy: georg.brandl, gregorlingl, loewis
severity: normal
status: open
title: Some functional errors in turtle.py documentation (missing links)
versions: Python 3.1

_______________________________________
Python tracker <report at bugs.python.org>
<http://bugs.python.org/issue6339>
_______________________________________


More information about the New-bugs-announce mailing list