Skip to content

Commit a184dbc

Browse files
cjihrigevanlucas
authored andcommitted
doc: update subprocess.killed
This commit changes the wording of subprocess.killed to reflect that a child process was successfully signaled, and not necessarily terminated. Fixes: #16747 PR-URL: #16748 Reviewed-By: Luigi Pinca <luigipinca@gmail.com> Reviewed-By: Rich Trott <rtrott@gmail.com> Reviewed-By: James M Snell <jasnell@gmail.com>
1 parent bce5db2 commit a184dbc

File tree

1 file changed

+4
-3
lines changed

1 file changed

+4
-3
lines changed

doc/api/child_process.md

+4-3
Original file line numberDiff line numberDiff line change
@@ -1044,10 +1044,11 @@ added: v0.5.10
10441044
-->
10451045

10461046
* {boolean} Set to `true` after `subprocess.kill()` is used to successfully
1047-
terminate the child process.
1047+
send a signal to the child process.
10481048

1049-
The `subprocess.killed` property indicates whether the child process was
1050-
successfully terminated using `subprocess.kill()`.
1049+
The `subprocess.killed` property indicates whether the child process
1050+
successfully received a signal from `subprocess.kill()`. The `killed` property
1051+
does not indicate that the child process has been terminated.
10511052

10521053
### subprocess.pid
10531054
<!-- YAML

0 commit comments

Comments
 (0)