From: Sebastian Rittau <srittau@rittau.biz>
Date: Wed, 22 Nov 2023 05:35:36 +0000 (+0100)
Subject: Fix docstring and var name of itertools recipe (#112113)
X-Git-Tag: v3.13.0a2~3
X-Git-Url: http://git.ipfire.org/gitweb.cgi?a=commitdiff_plain;h=6c47eaccfa2550c140a24bc6e520d968731d9689;p=thirdparty%2FPython%2Fcpython.git

Fix docstring and var name of itertools recipe (#112113)

`prepend()` works with arbitrary iterables, not only iterators. In fact,
the example given uses a `list`, which is iterable, but not an iterator.
---

diff --git a/Doc/library/itertools.rst b/Doc/library/itertools.rst
index f97e7f720ae4..ebb4ebcfa761 100644
--- a/Doc/library/itertools.rst
+++ b/Doc/library/itertools.rst
@@ -798,10 +798,10 @@ which incur interpreter overhead.
        "Return first n items of the iterable as a list"
        return list(islice(iterable, n))
 
-   def prepend(value, iterator):
-       "Prepend a single value in front of an iterator"
+   def prepend(value, iterable):
+       "Prepend a single value in front of an iterable"
        # prepend(1, [2, 3, 4]) --> 1 2 3 4
-       return chain([value], iterator)
+       return chain([value], iterable)
 
    def tabulate(function, start=0):
        "Return function(0), function(1), ..."