[Python-checkins] r81468 - python/trunk/Objects/enumobject.c
georg.brandl
python-checkins at python.org
Sat May 22 13:43:25 CEST 2010
Author: georg.brandl
Date: Sat May 22 13:43:25 2010
New Revision: 81468
Log:
#8635: document enumerate() start parameter in docstring.
Modified:
python/trunk/Objects/enumobject.c
Modified: python/trunk/Objects/enumobject.c
==============================================================================
--- python/trunk/Objects/enumobject.c (original)
+++ python/trunk/Objects/enumobject.c Sat May 22 13:43:25 2010
@@ -159,12 +159,13 @@
}
PyDoc_STRVAR(enum_doc,
-"enumerate(iterable) -> iterator for index, value of iterable\n"
+"enumerate(iterable[, start]) -> iterator for index, value of iterable\n"
"\n"
"Return an enumerate object. iterable must be another object that supports\n"
"iteration. The enumerate object yields pairs containing a count (from\n"
-"zero) and a value yielded by the iterable argument. enumerate is useful\n"
-"for obtaining an indexed list: (0, seq[0]), (1, seq[1]), (2, seq[2]), ...");
+"start, which defaults to zero) and a value yielded by the iterable argument.\n"
+"enumerate is useful for obtaining an indexed list:\n"
+" (0, seq[0]), (1, seq[1]), (2, seq[2]), ...");
PyTypeObject PyEnum_Type = {
PyVarObject_HEAD_INIT(&PyType_Type, 0)
More information about the Python-checkins
mailing list