Commit fbbe3478 authored by Jeremy Hylton's avatar Jeremy Hylton

Add a useful docstring to enumerate.

parent 631e87fb
......@@ -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)
......
Markdown is supported
0%
or
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment