[issue16523] attrgetter and itemgetter signatures in docs need cleanup

Chris Jerdonek report at bugs.python.org
Fri Nov 23 19:27:48 CET 2012


Chris Jerdonek added the comment:

You can also make that distinction using *.  For example:

.. function:: attrgetter(attr, *attrs)

or

.. function:: attrgetter(attr)
              attrgetter(attr1, attr2, *attrs)

(cf. http://docs.python.org/dev/library/functions.html#max )

Elsewhere we started to prefer using two signature lines where two or more "behaviors" are possible, which might be good to do in any case.  With the "..." notation, this would look like:

.. function:: attrgetter(attr)
              attrgetter(attr1, attr2, ...)

----------

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


More information about the Python-bugs-list mailing list