[Python-checkins] bpo-36760: Clarify subprocess capture_output docs. (GH-13322)

[Miss Islington (bot)]

https://github.com/python/cpython/commit/822683238c36e15f59d289075917ff7dedb5f4e6
commit: 822683238c36e15f59d289075917ff7dedb5f4e6
branch: 3.7
author: Miss Islington (bot) <31488909+miss-islington at users.noreply.github.com>
committer: GitHub <noreply at github.com>
date: 2019-05-14T12:39:17-07:00
summary:

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


Clarify how to capture stdout and stderr combined into one stream.
(cherry picked from commit e883091abf7ca84a88e956fe5202e75c53bd4128)

Co-authored-by: Gregory P. Smith <greg at krypto.org>

files:
M Doc/library/subprocess.rst

diff --git a/Doc/library/subprocess.rst b/Doc/library/subprocess.rst
index 0c1d892a34d8..f9ace6629521 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