summaryrefslogtreecommitdiff
path: root/Objects
diff options
context:
space:
mode:
authorGeorg Brandl <georg@python.org>2010-05-22 11:43:25 +0000
committerGeorg Brandl <georg@python.org>2010-05-22 11:43:25 +0000
commitefc74490722e436aeb274c3144a635d666ded96a (patch)
tree19b85414b9c814cd86d32acc912c1dc77a618545 /Objects
parentab2bd7e66d998ddac8f9fad19397e83e34e1d393 (diff)
downloadcpython-efc74490722e436aeb274c3144a635d666ded96a.tar.gz
#8635: document enumerate() start parameter in docstring.
Diffstat (limited to 'Objects')
-rw-r--r--Objects/enumobject.c7
1 files changed, 4 insertions, 3 deletions
diff --git a/Objects/enumobject.c b/Objects/enumobject.c
index a83fc7c461..1ef381f391 100644
--- a/Objects/enumobject.c
+++ b/Objects/enumobject.c
@@ -159,12 +159,13 @@ enum_next(enumobject *en)
}
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)