From: Georg Brandl Date: Mon, 12 May 2008 16:53:42 +0000 (+0000) Subject: Fix parameter name for enumerate(). X-Git-Tag: v2.6b1~457 X-Git-Url: https://granicus.if.org/sourcecode?a=commitdiff_plain;h=21f990cf0eea5c4fbab75d53ffd542eaaaa08477;p=python Fix parameter name for enumerate(). --- diff --git a/Doc/library/functions.rst b/Doc/library/functions.rst index 4232334414..bc07d84b02 100644 --- a/Doc/library/functions.rst +++ b/Doc/library/functions.rst @@ -335,14 +335,15 @@ available. They are listed here in alphabetical order. Using :func:`divmod` with complex numbers is deprecated. -.. function:: enumerate(iterable) - - Return an enumerate object. *iterable* must be a sequence, an :term:`iterator`, or some - other object which supports iteration. The :meth:`next` method of the iterator - returned by :func:`enumerate` returns a tuple containing a count (from zero) and - the corresponding value obtained from iterating over *iterable*. - :func:`enumerate` is useful for obtaining an indexed series: ``(0, seq[0])``, - ``(1, seq[1])``, ``(2, seq[2])``, .... For example: +.. function:: enumerate(sequence) + + Return an enumerate object. *sequence* must be a sequence, an + :term:`iterator`, or some other object which supports iteration. The + :meth:`next` method of the iterator returned by :func:`enumerate` returns a + tuple containing a count (from zero) and the corresponding value obtained + from iterating over *iterable*. :func:`enumerate` is useful for obtaining an + indexed series: ``(0, seq[0])``, ``(1, seq[1])``, ``(2, seq[2])``, .... For + example: >>> for i, season in enumerate(['Spring', 'Summer', 'Fall', 'Winter']): ... print i, season