Add note on capture_output arg to subprocess.run() docstring (GH-98012)

add note on capture_output arg to the docstring
(cherry picked from commit 80b3e32d62)

Co-authored-by: andrei kulakov <andrei.avk@gmail.com>
This commit is contained in:
Miss Islington (bot) 2022-10-07 10:55:26 -07:00 committed by GitHub
parent 245ea1f500
commit 69029bd2ca
No known key found for this signature in database
GPG key ID: 4AEE18F83AFDEB23

View file

@ -509,7 +509,8 @@ def run(*popenargs,
The returned instance will have attributes args, returncode, stdout and The returned instance will have attributes args, returncode, stdout and
stderr. By default, stdout and stderr are not captured, and those attributes stderr. By default, stdout and stderr are not captured, and those attributes
will be None. Pass stdout=PIPE and/or stderr=PIPE in order to capture them. will be None. Pass stdout=PIPE and/or stderr=PIPE in order to capture them,
or pass capture_output=True to capture both.
If check is True and the exit code was non-zero, it raises a If check is True and the exit code was non-zero, it raises a
CalledProcessError. The CalledProcessError object will have the return code CalledProcessError. The CalledProcessError object will have the return code