-
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: improve text for breakOnSigint #35692
Conversation
(<kbd>Ctrl</kbd>+<kbd>C</kbd>) is received. Existing handlers for the | ||
event that have been attached via `process.on('SIGINT')` are disabled | ||
during script execution, but continue to work after that. If execution | ||
is interrupted, an [`Error`][] is thrown. **Default:** `false`. |
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.
The word interrupted
here is the one thing I didn't modify for consistency. The other six instances say terminated
. I wasn't completely sure the choice wasn't intentional or which word was better than the other. @nodejs/vm @nodejs/documentation
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.
I think interrupt is a good word, especially given that that’s what SIGINT
stands for :)
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.
Should it be interrupted
on the other six instances then? I think consistency would be good, and @addaleax makes a good point.
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.
Should it be
interrupted
on the other six instances then?
I'll land this as-is and open a follow-on PR about that.
* Make the 7 instances of breakOnSigint text blocks consistent. * Use present tense. * Use kbd element for keystrokes. * Minor style edits. PR-URL: nodejs#35692 Reviewed-By: Luigi Pinca <luigipinca@gmail.com>
Landed in 6bf2139 |
* Make the 7 instances of breakOnSigint text blocks consistent. * Use present tense. * Use kbd element for keystrokes. * Minor style edits. PR-URL: #35692 Reviewed-By: Luigi Pinca <luigipinca@gmail.com>
* Make the 7 instances of breakOnSigint text blocks consistent. * Use present tense. * Use kbd element for keystrokes. * Minor style edits. PR-URL: #35692 Reviewed-By: Luigi Pinca <luigipinca@gmail.com>
* Make the 7 instances of breakOnSigint text blocks consistent. * Use present tense. * Use kbd element for keystrokes. * Minor style edits. PR-URL: #35692 Reviewed-By: Luigi Pinca <luigipinca@gmail.com>
* Make the 7 instances of breakOnSigint text blocks consistent. * Use present tense. * Use kbd element for keystrokes. * Minor style edits. PR-URL: #35692 Reviewed-By: Luigi Pinca <luigipinca@gmail.com>
Checklist