diff options
| author | Georg Brandl <georg@python.org> | 2010-05-22 11:43:25 (GMT) |
|---|---|---|
| committer | Georg Brandl <georg@python.org> | 2010-05-22 11:43:25 (GMT) |
| commit | 54d2898ef85271f8fba369826469c16d59267a1a (patch) | |
| tree | f058f152cc23086a09417962a002f8a8c64fe9aa | |
| parent | a19baf58e648705edb99013aa5bd23f6a0b65c8c (diff) | |
| download | cpython-54d2898ef85271f8fba369826469c16d59267a1a.zip cpython-54d2898ef85271f8fba369826469c16d59267a1a.tar.gz cpython-54d2898ef85271f8fba369826469c16d59267a1a.tar.bz2 | |
#8635: document enumerate() start parameter in docstring.
| -rw-r--r-- | Objects/enumobject.c | 7 |
1 files changed, 4 insertions, 3 deletions
diff --git a/Objects/enumobject.c b/Objects/enumobject.c index a83fc7c..1ef381f 100644 --- a/Objects/enumobject.c +++ b/Objects/enumobject.c @@ -159,12 +159,13 @@ enum_next(enumobject *en) } PyDoc_STRVAR(enum_doc, -"enumerate(iterable) -> iterator for index, value of iterable\n" +"enumerate(iterable[, start]) -> iterator for index, value of iterable\n" "\n" "Return an enumerate object. iterable must be another 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]), ..."); +"start, which defaults to zero) and a value yielded by the iterable argument.\n" +"enumerate is useful for obtaining an indexed list:\n" +" (0, seq[0]), (1, seq[1]), (2, seq[2]), ..."); PyTypeObject PyEnum_Type = { PyVarObject_HEAD_INIT(&PyType_Type, 0) |