traverseda
/
cpython
1
0
Fork 0
Code Issues Pull Requests Releases Wiki Activity

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

This commit is contained in:
Georg Brandl 2010-05-22 11:43:25 +00:00
parent a19baf58e6
commit 54d2898ef8
1 changed files with 4 additions and 3 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

7
Objects/enumobject.c
View File

@ -159,12 +159,13 @@ enum_next(enumobject *en)
} }
PyDoc_STRVAR(enum_doc, PyDoc_STRVAR(enum_doc,
"enumerate(iterable) -> iterator for index, value of iterable\n" "enumerate(iterable[, start]) -> iterator for index, value of iterable\n"
"\n" "\n"
"Return an enumerate object. iterable must be another object that supports\n" "Return an enumerate object. iterable must be another object that supports\n"
"iteration. The enumerate object yields pairs containing a count (from\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" "start, which defaults to zero) and a value yielded by the iterable argument.\n"
"for obtaining an indexed list: (0, seq[0]), (1, seq[1]), (2, seq[2]), ..."); "enumerate is useful for obtaining an indexed list:\n"
" (0, seq[0]), (1, seq[1]), (2, seq[2]), ...");
PyTypeObject PyEnum_Type = { PyTypeObject PyEnum_Type = {
PyVarObject_HEAD_INIT(&PyType_Type, 0) PyVarObject_HEAD_INIT(&PyType_Type, 0)