-
Notifications
You must be signed in to change notification settings - Fork 29.6k
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
doc: add documentation for killed
property of ChildProcess instance
#14578
Conversation
Do we really want to go there? Can we skip straight to |
I agree, it may be a good opportunity to improve the naming here. |
looking at the code if (this._handle) {
var err = this._handle.kill(signal);
if (err === 0) {
/* Success. */
this.killed = true;
return true;
} So |
TL;DR: I'd be more inclined to change A few things to bear in mind:
I'm happy to add a second commit to this PR that changes |
killed
property of ChildProcess instance
Sounds like a good solution. |
+1 to changing to |
One thing that changing to |
The anchor link breaks can be addressed by including |
Oooh, maybe we can only add the HTML markup in backports so they never show up in master. |
11c334e
to
62aaa34
Compare
OK, added the change to |
doc/api/child_process.md
Outdated
[`child.stderr`]: #child_process_child_stderr | ||
[`child.stdin`]: #child_process_child_stdin | ||
[`child.stdout`]: #child_process_child_stdout | ||
[subprocess.connected`]: #child_process_child_connected |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Missing opening backtick.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
@lpinca Oops, fixed, thanks!
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
LGTM with missing backticks added.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
LGTM % backtick fix
62aaa34
to
1cf009f
Compare
Great! I've tried to suggest such change here #14444 (comment) but no one liked the idea then :/ |
Checklist
make -j4 test
(UNIX), orvcbuild test
(Windows) passesAffected core subsystem(s)
doc child_process