Skip to content

Commit

Permalink
doc: update subprocess.killed
Browse files Browse the repository at this point in the history
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 <[email protected]>
Reviewed-By: Rich Trott <[email protected]>
Reviewed-By: James M Snell <[email protected]>
  • Loading branch information
cjihrig authored and evanlucas committed Nov 13, 2017
1 parent bce5db2 commit a184dbc
Showing 1 changed file with 4 additions and 3 deletions.
7 changes: 4 additions & 3 deletions doc/api/child_process.md
Original file line number Diff line number Diff line change
Expand Up @@ -1044,10 +1044,11 @@ added: v0.5.10
-->

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

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

### subprocess.pid
<!-- YAML
Expand Down

0 comments on commit a184dbc

Please sign in to comment.