]> git.ipfire.org Git - thirdparty/Python/cpython.git/commitdiff
[3.11] gh-87452: Improve the Popen.returncode docs (#103771)
authorMiss Islington (bot) <31488909+miss-islington@users.noreply.github.com>
Tue, 25 Apr 2023 16:15:48 +0000 (09:15 -0700)
committerGitHub <noreply@github.com>
Tue, 25 Apr 2023 16:15:48 +0000 (18:15 +0200)
Clarifies that it remains None until a method checking the child process
status has been called and noticed it has terminated.
(cherry picked from commit 68f583658247ceced323d79e1cf775c91c53c019)

Co-authored-by: Joshua Herman <30265+zitterbewegung@users.noreply.github.com>
Co-authored-by: Ɓukasz Langa <lukasz@langa.pl>
Doc/library/subprocess.rst

index 63d52062bc23f3e3226d558a0ee6802130b70871..4c7fb276311469746ab3e5f24af69b069515af4c 100644 (file)
@@ -921,9 +921,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).