Skip to content

Commit 54d2898

Browse files
committed
#8635: document enumerate() start parameter in docstring.
1 parent a19baf5 commit 54d2898

File tree

1 file changed

+4
-3
lines changed

1 file changed

+4
-3
lines changed

Objects/enumobject.c

Lines changed: 4 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -159,12 +159,13 @@ enum_next(enumobject *en)
159159
}
160160

161161
PyDoc_STRVAR(enum_doc,
162-
"enumerate(iterable) -> iterator for index, value of iterable\n"
162+
"enumerate(iterable[, start]) -> iterator for index, value of iterable\n"
163163
"\n"
164164
"Return an enumerate object. iterable must be another object that supports\n"
165165
"iteration. The enumerate object yields pairs containing a count (from\n"
166-
"zero) and a value yielded by the iterable argument. enumerate is useful\n"
167-
"for obtaining an indexed list: (0, seq[0]), (1, seq[1]), (2, seq[2]), ...");
166+
"start, which defaults to zero) and a value yielded by the iterable argument.\n"
167+
"enumerate is useful for obtaining an indexed list:\n"
168+
" (0, seq[0]), (1, seq[1]), (2, seq[2]), ...");
168169

169170
PyTypeObject PyEnum_Type = {
170171
PyVarObject_HEAD_INIT(&PyType_Type, 0)

0 commit comments

Comments
 (0)