From: Gregory P. Smith <greg@krypto.org>
Date: Tue, 14 May 2019 19:33:17 +0000 (-0700)
Subject: bpo-36760: Clarify subprocess capture_output docs. (GH-13322)
X-Git-Tag: v3.8.0b1~363
X-Git-Url: https://granicus.if.org/sourcecode?a=commitdiff_plain;h=e883091abf7ca84a88e956fe5202e75c53bd4128;p=python

bpo-36760: Clarify subprocess capture_output docs. (GH-13322)

Clarify how to capture stdout and stderr combined into one stream.
---

diff --git a/Doc/library/subprocess.rst b/Doc/library/subprocess.rst
index 3280c95cac..d840b461f9 100644
--- a/Doc/library/subprocess.rst
+++ b/Doc/library/subprocess.rst
@@ -55,7 +55,9 @@ compatibility with older versions, see the :ref:`call-function-trio` section.
    If *capture_output* is true, stdout and stderr will be captured.
    When used, the internal :class:`Popen` object is automatically created with
    ``stdout=PIPE`` and ``stderr=PIPE``. The *stdout* and *stderr* arguments may
-   not be supplied at the same time as *capture_output*.
+   not be supplied at the same time as *capture_output*.  If you wish to capture
+   and combine both streams into one, use ``stdout=PIPE`` and ``stderr=STDOUT``
+   instead of *capture_output*.
 
    The *timeout* argument is passed to :meth:`Popen.communicate`. If the timeout
    expires, the child process will be killed and waited for.  The