Skip to content

Commit c4634bf

Browse files
cjihrigMylesBorins
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 8d31294 commit c4634bf

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
@@ -1048,10 +1048,11 @@ added: v0.5.10
10481048
-->
10491049

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

1053-
The `subprocess.killed` property indicates whether the child process was
1054-
successfully terminated using `subprocess.kill()`.
1053+
The `subprocess.killed` property indicates whether the child process
1054+
successfully received a signal from `subprocess.kill()`. The `killed` property
1055+
does not indicate that the child process has been terminated.
10551056

10561057
<a name="child_process_child_pid"></a>
10571058
### subprocess.pid

0 commit comments

Comments
 (0)