Merged revisions 81468 via svnmerge from
authorGeorg Brandl <georg@python.org>
Sat, 22 May 2010 11:44:30 +0000 (11:44 +0000)
committerGeorg Brandl <georg@python.org>
Sat, 22 May 2010 11:44:30 +0000 (11:44 +0000)
svn+ssh://pythondev@svn.python.org/python/trunk

........
  r81468 | georg.brandl | 2010-05-22 13:43:25 +0200 (Sa, 22 Mai 2010) | 1 line

  #8635: document enumerate() start parameter in docstring.
........

Objects/enumobject.c

index 69137092d36f6c911b7064fd2f20d046850a15ce..d0c8782966f4946dc8d156d2e41a6453ab8e3405 100644 (file)
@@ -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)