Docs: Clarify the before_and_after() example (GH-28458) (#28464)

(cherry picked from commit fcbf9b1) Co-authored-by: Raymond Hettinger <rhettinger@users.noreply.github.com> Co-authored-by: Raymond Hettinger <rhettinger@users.noreply.github.com>
python · Sep 29, 2021 · 0a74d33 · 0a74d33
1 parent 2e4d66d
commit 0a74d33
Show file tree

Hide file tree

Showing 2 changed files with 8 additions and 6 deletions.
diff --git a/Doc/library/itertools.rst b/Doc/library/itertools.rst
@@ -859,10 +859,11 @@ which incur interpreter overhead.
        """ Variant of takewhile() that allows complete
            access to the remainder of the iterator.
 
-           >>> all_upper, remainder = before_and_after(str.isupper, 'ABCdEfGhI')
-           >>> str.join('', all_upper)
+           >>> it = iter('ABCdEfGhI')
+           >>> all_upper, remainder = before_and_after(str.isupper, it)
+           >>> ''.join(all_upper)
            'ABC'
-           >>> str.join('', remainder)
+           >>> ''.join(remainder)     # takewhile() would lose the 'd'
            'dEfGhI'
 
            Note that the first iterator must be fully

diff --git a/Lib/test/test_itertools.py b/Lib/test/test_itertools.py
@@ -2604,10 +2604,11 @@ def test_permutations_sizeof(self):
 >>> list(odds)
 [1, 3, 5, 7, 9]
 
->>> all_upper, remainder = before_and_after(str.isupper, 'ABCdEfGhI')
->>> str.join('', all_upper)
+>>> it = iter('ABCdEfGhI')
+>>> all_upper, remainder = before_and_after(str.isupper, it)
+>>> ''.join(all_upper)
 'ABC'
->>> str.join('', remainder)
+>>> ''.join(remainder)
 'dEfGhI'
 
 >>> list(powerset([1,2,3]))