Skip to content
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.

Sign up for GitHub

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

Jump to bottom

doc: improve text for breakOnSigint #35692

Merged
merged 1 commit into from Oct 24, 2020
Merged

doc: improve text for breakOnSigint #35692

merged 1 commit into from Oct 24, 2020

Conversation

Trott
Copy link
Member

@Trott Trott commented Oct 17, 2020

  • Make the 7 instances of breakOnSigint text blocks consistent.
  • Use present tense.
  • Use kbd element for keystrokes.
  • Minor style edits.
Checklist

@nodejs-github-bot nodejs-github-bot added doc Issues and PRs related to the documentations. vm Issues and PRs related to the vm subsystem. labels Oct 17, 2020
Trott
Trott commented Oct 17, 2020
View reviewed changes
doc/api/vm.md
(<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`.
Copy link
Member Author

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

Copy link
Member

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 :)

Copy link
Contributor

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.

Copy link
Member Author

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.

@Trott
Copy link
Member Author

Trott commented Oct 18, 2020

Before:

image

After:

image

@Trott
doc: improve text for breakOnSigint
6bf2139 
* 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>
@Trott Trott merged commit 6bf2139 into nodejs:master Oct 24, 2020
@Trott
Copy link
Member Author

Trott commented Oct 24, 2020

Landed in 6bf2139

@Trott Trott deleted the breakOnSigInt branch October 24, 2020 12:16
targos pushed a commit that referenced this pull request Nov 3, 2020
@Trott @targos
doc: improve text for breakOnSigint
890b03e 
* 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>
@targos targos mentioned this pull request Nov 3, 2020
Merged
BethGriggs pushed a commit that referenced this pull request Dec 8, 2020
@Trott @BethGriggs
doc: improve text for breakOnSigint
c15e8a5 
* 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>
BethGriggs pushed a commit that referenced this pull request Dec 10, 2020
@Trott @BethGriggs
doc: improve text for breakOnSigint
f2e7560 
* 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>
@BethGriggs BethGriggs mentioned this pull request Dec 10, 2020
Merged
BethGriggs pushed a commit that referenced this pull request Dec 15, 2020
@Trott @BethGriggs
doc: improve text for breakOnSigint
47ba122 
* 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>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@addaleax addaleax addaleax left review comments

@aduh95 aduh95 aduh95 left review comments

@lpinca lpinca lpinca approved these changes

@aymen94 aymen94 aymen94 approved these changes

@randomhash randomhash randomhash approved these changes

Assignees
No one assigned
Labels
doc Issues and PRs related to the documentations. vm Issues and PRs related to the vm subsystem.
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.

None yet
7 participants
@Trott @addaleax @lpinca @aymen94 @aduh95 @randomhash @nodejs-github-bot