[docs] [issue12192] Doc that collection mutation methods return item or None

Daniel Stutzbach report at bugs.python.org
Fri May 27 18:45:37 CEST 2011

Daniel Stutzbach <stutzbach at google.com> added the comment:

> Comment: This rule applies to special methods like __getitem__
> and __setitem__. 'lis.append(item)' is equivalent to
> lis.__setitem__(len(lis):len(lis), item), so it should not be so
> surprising that it has the same return.

It's not true for all special methods.  __iadd__ and __imul__ return the list itself.

That's a minor nitpick though.  +1 on adding "and return None" to the docstrings of methods that often trip people up.  Not everyone will read them, but some people will.

nosy: +stutzbach

Python tracker <report at bugs.python.org>

More information about the docs mailing list