[issue10122] Documentation typo fix and a side question

New submission from Retro <vinetouu@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@python components: Documentation messages: 118869 nosy: Retro, docs@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@bugs.python.org> <http://bugs.python.org/issue10122> _______________________________________

R. David Murray <rdmurray@bitdance.com> added the comment: No, that would be incorrect syntax (if you omit the optional argument you should also omit the comma that precedes it). ---------- nosy: +r.david.murray _______________________________________ Python tracker <report@bugs.python.org> <http://bugs.python.org/issue10122> _______________________________________

Changes by R. David Murray <rdmurray@bitdance.com>: ---------- type: -> behavior versions: -3rd party, Python 2.5, Python 2.6, Python 3.3 _______________________________________ Python tracker <report@bugs.python.org> <http://bugs.python.org/issue10122> _______________________________________

Georg Brandl <georg@python.org> added the comment: Typo fixed in r85572. Otherwise, as David says. ---------- nosy: +georg.brandl resolution: -> fixed status: open -> closed _______________________________________ Python tracker <report@bugs.python.org> <http://bugs.python.org/issue10122> _______________________________________

Boštjan Mejak <bostjan.mejak@gmail.com> added the comment: If you visit http://docs.python.org/library/functions.html?highlight=getattr#getattr there is still the word 'attributed' present in online docs. Please fix the docs completely. ---------- _______________________________________ Python tracker <report@bugs.python.org> <http://bugs.python.org/issue10122> _______________________________________

Senthil Kumaran <orsenthil@gmail.com> added the comment: Boštjan, it is fixed. The change will reflect when the docs get served from the updated version. Also, Georg will take care of merging it to other branches. ---------- nosy: +orsenthil _______________________________________ Python tracker <report@bugs.python.org> <http://bugs.python.org/issue10122> _______________________________________

Boštjan Mejak <bostjan.mejak@gmail.com> added the comment: The change is still not reflected. Why not? It's been more than a month now. What is going on? ---------- _______________________________________ Python tracker <report@bugs.python.org> <http://bugs.python.org/issue10122> _______________________________________

Georg Brandl <georg@python.org> added the comment: I don't waste my time by merging every little typo fix to the maintenance branches immediately; I rather merge them all at once every now and then. You will certainly understand that nobody is harmed by a stray "d", even if it has a pointy tip. ---------- _______________________________________ Python tracker <report@bugs.python.org> <http://bugs.python.org/issue10122> _______________________________________
participants (5)
-
Boštjan Mejak
-
Georg Brandl
-
R. David Murray
-
Retro
-
Senthil Kumaran