summaryrefslogtreecommitdiffstats
diff options
context:
space:
mode:
authorRaymond Hettinger <python@rcn.com>2012-12-28 08:03:30 (GMT)
committerRaymond Hettinger <python@rcn.com>2012-12-28 08:03:30 (GMT)
commitc195b4e88c39f58dccea0678ec517c1632d337f4 (patch)
tree97fbd23a8a5ae5edfada103df3df19c204b62780
parent3684c79e00ad923fa2400458c1a02d6afa3c5ce8 (diff)
downloadcpython-c195b4e88c39f58dccea0678ec517c1632d337f4.zip
cpython-c195b4e88c39f58dccea0678ec517c1632d337f4.tar.gz
cpython-c195b4e88c39f58dccea0678ec517c1632d337f4.tar.bz2
Make the from_iterable() recipe more usable.
The code isn't exactly equivalent because a classmethod would only make sense inside a chain class, and it would need "cls" as a first argument, and it would need to return an instance of "chain" rather than a generator. The updated example drops the @classmethod decorator so that it can be used standalone: list(from_iterable(['abc', 'def'])) This should be communicate what from_iterable does.
-rw-r--r--Doc/library/itertools.rst3
1 files changed, 1 insertions, 2 deletions
diff --git a/Doc/library/itertools.rst b/Doc/library/itertools.rst
index 8bb9e36..a7f0058 100644
--- a/Doc/library/itertools.rst
+++ b/Doc/library/itertools.rst
@@ -106,9 +106,8 @@ loops that truncate the stream.
.. classmethod:: chain.from_iterable(iterable)
Alternate constructor for :func:`chain`. Gets chained inputs from a
- single iterable argument that is evaluated lazily. Equivalent to::
+ single iterable argument that is evaluated lazily. Roughly equivalent to::
- @classmethod
def from_iterable(iterables):
# chain.from_iterable(['ABC', 'DEF']) --> A B C D E F
for it in iterables: