[New-bugs-announce] [issue10122] Documentation typo fix and a side question

Retro report at bugs.python.org
Sat Oct 16 16:09:04 CEST 2010


New submission from Retro <vinetouu at gmail.com>:

Please read the first sentence of the docs for the built-in function getattr() here: http://docs.python.org/library/functions.html?highlight=getattr#getattr

Fix the word 'attributed' to 'attribute', because the former is a typo.



A side question. When you document an object's API in the docstring, you write it like this:
getattr(object, name[, default]) -> value

Don't you find it nicer if that would look like this:
getattr(object, name, [default]) -> value

Note the cosmetic fix between the arguments 'name' and 'default'. Do you find my fix acceptable? If yes, please fix docstrings in Python that document the object's API from the '...name[, default]...' format to '...name, [default]...' format.

----------
assignee: docs at python
components: Documentation
messages: 118869
nosy: Retro, docs at python
priority: normal
severity: normal
status: open
title: Documentation typo fix and a side question
versions: 3rd party, Python 2.5, Python 2.6, Python 2.7, Python 3.1, Python 3.2, Python 3.3

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


More information about the New-bugs-announce mailing list