mirrors/cpython
1
0
Fork 0
mirror of https://github.com/python/cpython.git synced 2025-12-15 21:44:50 +00:00
Code Issues Projects Releases Packages Wiki Activity Actions 12

Add a useful docstring to enumerate.

Browse source
This commit is contained in:
Jeremy Hylton 2003-04-21 20:26:25 +00:00
parent 631e87fb3d
commit fbbe34789e
1 changed files with 6 additions and 1 deletions
Download patch file Download diff file Expand all files Collapse all files

7
Objects/enumobject.c
View file

@ -79,7 +79,12 @@ enum_next(enumobject *en)
}
PyDoc_STRVAR(enum_doc,
"enumerate(iterable) -> create an enumerating-iterator");
"enumerate(iterable) -> iterator for index, value of iterable\n"
"\n"
"Return an enumerate object. iterable must be an other 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]), ...");
PyTypeObject PyEnum_Type = {
PyObject_HEAD_INIT(&PyType_Type)