From: Georg Brandl <georg@python.org>
Date: Sat, 22 May 2010 11:43:25 +0000 (+0000)
Subject: #8635: document enumerate() start parameter in docstring.
X-Git-Tag: v2.7rc1~104
X-Git-Url: http://git.ipfire.org/?a=commitdiff_plain;h=54d2898ef85271f8fba369826469c16d59267a1a;p=thirdparty%2FPython%2Fcpython.git

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

diff --git a/Objects/enumobject.c b/Objects/enumobject.c
index a83fc7c4615e..1ef381f39142 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)