From fbbe34789e62725cac074a188826e53d8cc95e16 Mon Sep 17 00:00:00 2001 From: Jeremy Hylton Date: Mon, 21 Apr 2003 20:26:25 +0000 Subject: Add a useful docstring to enumerate. --- Objects/enumobject.c | 7 ++++++- 1 file changed, 6 insertions(+), 1 deletion(-) diff --git a/Objects/enumobject.c b/Objects/enumobject.c index c7e4365..66ee870 100644 --- a/Objects/enumobject.c +++ b/Objects/enumobject.c @@ -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) -- cgit v0.12