[Python-checkins] gh-87452: Improve the Popen.returncode docs

gpshead webhook-mailer at python.org
Mon Apr 24 12:46:20 EDT 2023


https://github.com/python/cpython/commit/68f583658247ceced323d79e1cf775c91c53c019
commit: 68f583658247ceced323d79e1cf775c91c53c019
branch: main
author: Joshua Herman <30265+zitterbewegung at users.noreply.github.com>
committer: gpshead <greg at krypto.org>
date: 2023-04-24T09:46:12-07:00
summary:

gh-87452: Improve the Popen.returncode docs

Clarifies that it remains None until a method checking the child process status has been called and noticed it has terminated.

files:
M Doc/library/subprocess.rst

diff --git a/Doc/library/subprocess.rst b/Doc/library/subprocess.rst
index 2b5a82e0107f..53dfbf827260 100644
--- a/Doc/library/subprocess.rst
+++ b/Doc/library/subprocess.rst
@@ -919,9 +919,12 @@ Reassigning them to new values is unsupported:
 
 .. attribute:: Popen.returncode
 
-   The child return code, set by :meth:`poll` and :meth:`wait` (and indirectly
-   by :meth:`communicate`).  A ``None`` value indicates that the process
-   hasn't terminated yet.
+   The child return code. Initially ``None``, :attr:`returncode` is set by
+   a call to the :meth:`poll`, :meth:`wait`, or :meth:`communicate` methods
+   if they detect that the process has terminated.
+
+   A ``None`` value indicates that the process hadn't yet terminated at the
+   time of the last method call.
 
    A negative value ``-N`` indicates that the child was terminated by signal
    ``N`` (POSIX only).



More information about the Python-checkins mailing list