diff options
author | Giampaolo Rodola <g.rodola@gmail.com> | 2019-12-29 00:11:04 +0100 |
---|---|---|
committer | Giampaolo Rodola <g.rodola@gmail.com> | 2019-12-29 00:11:04 +0100 |
commit | f170fb8a9ad07edda6ed12c150570a0ad33ee2f0 (patch) | |
tree | 07f325caf832550e1e1eb3e3603e6dd631a6c87e | |
parent | 03b29d040881f55eb098e78e71c96164edfb73ec (diff) | |
download | psutil-f170fb8a9ad07edda6ed12c150570a0ad33ee2f0.tar.gz |
update/fix wait_procs() doc
-rw-r--r-- | docs/index.rst | 6 |
1 files changed, 3 insertions, 3 deletions
diff --git a/docs/index.rst b/docs/index.rst index 5ed3bb7c..6df32819 100644 --- a/docs/index.rst +++ b/docs/index.rst @@ -932,11 +932,11 @@ Functions Convenience function which waits for a list of :class:`Process` instances to terminate. Return a ``(gone, alive)`` tuple indicating which processes are gone and which ones are still alive. The *gone* ones will have a new - *returncode* attribute indicating process exit status (will be ``None`` for - processes which are not our children). + *returncode* attribute indicating process exit status as returned by + :meth:`Process.wait`. ``callback`` is a function which gets called when one of the processes being waited on is terminated and a :class:`Process` instance is passed as callback - argument). + argument (the instance will also have a *returncode* attribute set). This function will return as soon as all processes terminate or when *timeout* (seconds) occurs. Differently from :meth:`Process.wait` it will not raise |