From: Miss Islington (bot) <31488909+miss-islington@users.noreply.github.com>
Date: Wed, 26 May 2021 14:43:37 +0000 (-0700)
Subject: bpo-41147: [doc] contextlib.redirect_stdout() provides the new stream as context... 
X-Git-Tag: v3.9.6~57
X-Git-Url: http://git.ipfire.org/gitweb.cgi?a=commitdiff_plain;h=bee66d3cb98e740f9d8057eb7f503122052ca5d8;p=thirdparty%2FPython%2Fcpython.git

bpo-41147: [doc] contextlib.redirect_stdout() provides the new stream as context var (GH-21199) (GH-26380)

(cherry picked from commit 46db39d7bd67fb9fea133cd4f18cdf7eacb0f6d9)

Co-authored-by: Peter Law <PeterJCLaw@gmail.com>
---

diff --git a/Doc/library/contextlib.rst b/Doc/library/contextlib.rst
index aa848df8c429..3dcedf72a390 100644
--- a/Doc/library/contextlib.rst
+++ b/Doc/library/contextlib.rst
@@ -236,10 +236,11 @@ Functions and classes provided:
 
    For example, the output of :func:`help` normally is sent to *sys.stdout*.
    You can capture that output in a string by redirecting the output to an
-   :class:`io.StringIO` object::
+   :class:`io.StringIO` object. The replacement stream is returned from the
+   ``__enter__`` method and so is available as the target of the
+   :keyword:`with` statement::
 
-        f = io.StringIO()
-        with redirect_stdout(f):
+        with redirect_stdout(io.StringIO()) as f:
             help(pow)
         s = f.getvalue()