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.
This commit is contained in:
Joshua Herman 2023-04-24 10:46:12 -06:00 committed by GitHub
parent 385d8d2b64
commit 68f5836582
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23

View File

@ -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).