doc: update subprocess.killed #16748
Merged
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
nodejs-github-bot
added
child_process
lpinca
approved these changes
Nov 4, 2017
Trott
approved these changes
Nov 4, 2017
doc/api/child_process.md
Outdated
| @@ -1044,10 +1044,10 @@ added: v0.5.10 | |||
| --> | |||
|
|
|||
| * {boolean} Set to `true` after `subprocess.kill()` is used to successfully | |||
| terminate the child process. | |||
| signal the child process. | |||
There was a problem hiding this comment.
Bikeshed : successfully signal -> successfully send a signal to?
There was a problem hiding this comment.
Up to me, proposal of @Trott is much better
doc/api/child_process.md
Outdated
|
|
||
| The `subprocess.killed` property indicates whether the child process was | ||
| successfully terminated using `subprocess.kill()`. | ||
| successfully signaled using `subprocess.kill()`. |
There was a problem hiding this comment.
Bikeshed: was successfully signaled using -> successfully received a signal from?
|
Maybe it's worth to explicitly point out that even in the case of Some developers may not distinguish 'terminated' and 'signaled' terms correctly, so additional explanation will be helpful. After all it's a sign of a good documentation. |
jasnell
approved these changes
Nov 6, 2017
cjihrig
force-pushed
the
kill-docs
branch
2 times, most recently
from
f5ec3d4
to
8db8c2c
Compare
This commit changes the wording of subprocess.killed to reflect that a child process was successfully signaled, and not necessarily terminated. Fixes: nodejs#16747 PR-URL: nodejs#16748 Reviewed-By: Luigi Pinca <luigipinca@gmail.com> Reviewed-By: Rich Trott <rtrott@gmail.com> Reviewed-By: James M Snell <jasnell@gmail.com>
evanlucas
pushed a commit
that referenced
this pull request
Nov 13, 2017
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>
Merged
MylesBorins
pushed a commit
that referenced
this pull request
Nov 17, 2017
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>
MylesBorins
pushed a commit
that referenced
this pull request
Nov 17, 2017
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>
Merged
Merged
MylesBorins
pushed a commit
that referenced
this pull request
Nov 21, 2017
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>
MylesBorins
pushed a commit
that referenced
this pull request
Nov 28, 2017
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>
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
This commit changes the wording of
subprocess.killedto reflect that a child process was successfully signaled, and not necessarily terminated.Fixes: #16747
Checklist
make -j4 test(UNIX), orvcbuild test(Windows) passesAffected core subsystem(s)
doc