FazBrowse GitHub Viewer | Trending |
URL:
| Home
Tools: [Download Repo ZIP]   [Original HTTPS Page]

doc: general improvements to events documentation by thefourtheye · Pull Request #7480 · nodejs/node · GitHub

/ node Public

doc: general improvements to events documentation - #7480

Closed
thefourtheye wants to merge 2 commits into
nodejs:masterfrom
thefourtheye:events-doc-improvment
ConversationCommits (2)ChecksFiles changed
Closed

doc: general improvements to events documentation#7480
thefourtheye wants to merge 2 commits into
nodejs:masterfrom
thefourtheye:events-doc-improvment

Conversation

thefourtheye commented Jun 29, 2016

Copy link
Copy Markdown
Contributor
Checklist
  • documentation is changed or added
  • commit message follows commit guidelines
Affected core subsystem(s)

doc, events

Description of change

general doc improvements

cc @nodejs/documentation

thefourtheye added doc Issues and PRs related to the documentations. events Issues and PRs related to the events subsystem / EventEmitter. labels Jun 29, 2016
thefourtheye force-pushed the events-doc-improvment branch from 2730b17 to 5ed2bdc Compare June 29, 2016 17:55
mscdex reviewed Jun 29, 2016
View reviewed changes
Comment thread doc/api/events.md Outdated

mscdex Jun 29, 2016

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Choose a reason Spam Abuse Off Topic Outdated Duplicate Resolved Low Quality

"the process.on('uncaughtException') event" is confusing since it's a piece of code and not just the event name.

jasnell Jun 29, 2016

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Choose a reason Spam Abuse Off Topic Outdated Duplicate Resolved Low Quality

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...

mscdex Jun 30, 2016 •
edited
Loading

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Choose a reason Spam Abuse Off Topic Outdated Duplicate Resolved Low Quality

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.

jasnell commented Jun 29, 2016

Copy link
Copy Markdown
Member

Great to see this. Left some comments!

thefourtheye force-pushed the events-doc-improvment branch from 5ed2bdc to 7f51b34 Compare June 30, 2016 17:08

thefourtheye commented Jun 30, 2016

Copy link
Copy Markdown
Contributor Author

Addressed comments @jasnell and @mscdex

jasnell commented Jun 30, 2016

Copy link
Copy Markdown
Member

LGTM

thefourtheye commented Jul 8, 2016

Copy link
Copy Markdown
Contributor Author

Bump!

thefourtheye commented Jul 13, 2016

Copy link
Copy Markdown
Contributor Author

Landing this tomorrow if there are no more comments.

thefourtheye commented Jul 20, 2016

Copy link
Copy Markdown
Contributor Author

Landed in af49158. Thanks @jasnell :-)

thefourtheye deleted the events-doc-improvment branch July 20, 2016 04:44
thefourtheye added a commit that referenced this pull request Jul 20, 2016
doc: general improvments to events documentation
af49158 
PR-URL: #7480
Reviewed-By: James M Snell <jasnell@gmail.com>
evanlucas pushed a commit that referenced this pull request Jul 21, 2016
doc: general improvments to events documentation
3343d46 
PR-URL: #7480
Reviewed-By: James M Snell <jasnell@gmail.com>
evanlucas mentioned this pull request Jul 21, 2016
Merged
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
Show hidden characters
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Reviewers

No reviews

Assignees

No one assigned

Labels

doc Issues and PRs related to the documentations. events Issues and PRs related to the events subsystem / EventEmitter.

Projects

None yet

Milestone

No milestone

Development

Successfully merging this pull request may close these issues.

5 participants

Back | FazBrowse Home | New Git URL