doc: general improvements to events documentation#7480
Closed
+28 −28
Conversation
This file contains hidden or 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
thefourtheye added doc thefourtheyeforce-pushed the events-doc-improvment branch from 2730b17 to 5ed2bdcCompare
doc/api/events.md Outdated
Contributor
There was a problem hiding this comment.
"the process.on('uncaughtException') event" is confusing since it's a piece of code and not just the event name.
Member
There was a problem hiding this comment.
Perhaps:
To guard against crashing the Node.js process, a listener can be registered on the `process` object's `'uncaughtException'` event (e.g. `process.on('uncaughtException', (err) => /* ... */)`) or the [`domain`][] module can be used... Contributor
There was a problem hiding this comment.
That seems mostly alright to me, except I think if we're going to have a code example like that, it shouldn't be inline, it takes up too much space IMHO.
Member
jasnell commented Jun 29, 2016
Great to see this. Left some comments! |
thefourtheyeforce-pushed the events-doc-improvment branch from 5ed2bdc to 7f51b34Compare
ContributorAuthor
thefourtheye commented Jun 30, 2016
Member
jasnell commented Jun 30, 2016
LGTM |
ContributorAuthor
thefourtheye commented Jul 8, 2016
Bump! |
ContributorAuthor
thefourtheye commented Jul 13, 2016
Landing this tomorrow if there are no more comments. |
ContributorAuthor
thefourtheye commented Jul 20, 2016
thefourtheye added a commit that referenced this pull request Jul 20, 2016
PR-URL: #7480 Reviewed-By: James M Snell <[email protected]>
evanlucas pushed a commit that referenced this pull request Jul 21, 2016
PR-URL: #7480 Reviewed-By: James M Snell <[email protected]>
Sign up for freeto join this conversation on GitHub. Already have an account? Sign in to comment
5 participants
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.
Checklist
Affected core subsystem(s)
doc, events
Description of change
general doc improvements
cc @nodejs/documentation