diff Objects/enumobject.c @ 61856:d6a88969717f legacy-trunk

#8635: document enumerate() start parameter in docstring.
author Georg Brandl <georg@python.org>
date Sat, 22 May 2010 11:43:25 +0000
parents fd25030223b0
children b36cb4602e21
line wrap: on
line diff
--- a/Objects/enumobject.c	Sat May 22 11:31:16 2010 +0000
+++ b/Objects/enumobject.c	Sat May 22 11:43:25 2010 +0000
@@ -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)