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

doc: add comment for net.Server's error event by jjqq2013 · Pull Request #11136 · nodejs/node · GitHub

/ node Public

doc: add comment for net.Server's error event - #11136

Closed
jjqq2013 wants to merge 1 commit into
nodejs:masterfrom
sjitech:doc-server-error
ConversationCommits (1)ChecksFiles changed
Closed

doc: add comment for net.Server's error event#11136
jjqq2013 wants to merge 1 commit into
nodejs:masterfrom
sjitech:doc-server-error

Conversation

jjqq2013 commented Feb 3, 2017

Copy link
Copy Markdown
Contributor

Fix: #9710

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

doc

nodejs-github-bot added doc Issues and PRs related to the documentations. net Issues and PRs related to the net subsystem. labels Feb 3, 2017
addaleax approved these changes Feb 3, 2017
View reviewed changes

addaleax left a comment

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

Looks good, with a small nit.

Two things regarding the commit message though:

  1. Your author name in this commit is given as “q”. Is that intended or do you prefer to be listed (changelog, git log, AUTHORS file) with some other name? People typically prefer their full name, but ultimately it’s up to you.

  2. Could you use Fixes: instead of Fix:? 😄 It’s not important, but the former is more commonly used around here.

Comment thread doc/api/net.md Outdated

addaleax Feb 3, 2017

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

Can you drop the, or replace it with with? (not a native speaker myself but the the sounds odd here)

jjqq2013 Feb 3, 2017

Copy link
Copy Markdown
Contributor Author

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

Of course, thank you!

jjqq2013 force-pushed the doc-server-error branch 2 times, most recently from ef32fb1 to 5cbd17a Compare February 3, 2017 07:27
jasnell requested changes Feb 3, 2017
View reviewed changes
Comment thread doc/api/net.md Outdated

jasnell Feb 3, 2017

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

Please avoid the use of pronouns like you in the documentation. Also, please use either italics or bold for emphasis as opposed to upper case (e.g. NOT) This can be reworded as:

Emitted when an error occurs., Unlike [`net.Socket'`[], the [`'close'`][]
event will **not** be called directly following this event unless
`server.close()` is manually called. See the example in the discussion
of `server.listen()`.

jjqq2013 Feb 4, 2017 •
edited
Loading

Copy link
Copy Markdown
Contributor Author

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

Thanks.

The net.Socket is not an event, so can not be displayed as a link by ['net.Socket'][], this is why i just use [net.Socket][].

Besides, "See the example in the discussion", two "the" seems odd? So i stripped second "the".

See my second commit's preview: https://github.com/sjitech/node/blob/3b440d3db2a2dfa9833eb06ede6f1adb909c1644/doc/api/net.md#event-error

jjqq2013 commented Feb 5, 2017

Copy link
Copy Markdown
Contributor Author

The http.Server has the same behavior, but i can not found any description about 'error' event of http.Server, should we add same note?

sam-github suggested changes Feb 8, 2017
View reviewed changes
Comment thread doc/api/net.md Outdated

sam-github Feb 8, 2017

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

events are "emitted", not "called"

jjqq2013 Feb 9, 2017

Copy link
Copy Markdown
Contributor Author

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

ok, i will correct it and the original description.

sam-github commented Feb 10, 2017

Copy link
Copy Markdown
Contributor

The http.Server has the same behavior, but i can not found any description about 'error' event of http.Server, should we add same note?

Yes.

jjqq2013 commented Feb 11, 2017

Copy link
Copy Markdown
Contributor Author

sorry, i found the http.Server has already mentioned

This class inherits from net.Server and has the following additional events

So i think no need to add description of error event.

sam-github approved these changes Feb 11, 2017
View reviewed changes
Comment thread doc/api/net.md Outdated

sam-github Feb 11, 2017

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

would be good to link server.close() and server.listen()

jasnell Feb 17, 2017

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

@QianJin2013 ... please see @sam-github's comment above :-)

jjqq2013 Feb 17, 2017

Copy link
Copy Markdown
Contributor Author

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

@sam-github I'd tried to link server.close() and server.listen() but failed. Now i know the reason, i have modified doc again.

sam-github commented Feb 11, 2017

Copy link
Copy Markdown
Contributor

you'll need to squash and rebase

jjqq2013 commented Feb 12, 2017

Copy link
Copy Markdown
Contributor Author

@sam-github yes, i will squash and rebase it.

jjqq2013 force-pushed the doc-server-error branch 3 times, most recently from 6eb63c9 to 72b4bd3 Compare February 17, 2017 02:13

sam-github commented Feb 20, 2017

Copy link
Copy Markdown
Contributor

Landed in 52ddb41. thanks.

sam-github closed this Feb 20, 2017
sam-github pushed a commit that referenced this pull request Feb 20, 2017
doc: add comment for net.Server's error event
52ddb41 
Fixes: #9710
PR-URL: #11136
Reviewed-By: Anna Henningsen <anna@addaleax.net>
Reviewed-By: James M Snell <jasnell@gmail.com>
Reviewed-By: Sam Roberts <vieuxtech@gmail.com>
addaleax pushed a commit that referenced this pull request Feb 22, 2017
doc: add comment for net.Server's error event
98eb18b 
Fixes: #9710
PR-URL: #11136
Reviewed-By: Anna Henningsen <anna@addaleax.net>
Reviewed-By: James M Snell <jasnell@gmail.com>
Reviewed-By: Sam Roberts <vieuxtech@gmail.com>
italoacasas mentioned this pull request Feb 25, 2017
Merged
jasnell pushed a commit that referenced this pull request Mar 7, 2017
doc: add comment for net.Server's error event
ebb3a09 
Fixes: #9710
PR-URL: #11136
Reviewed-By: Anna Henningsen <anna@addaleax.net>
Reviewed-By: James M Snell <jasnell@gmail.com>
Reviewed-By: Sam Roberts <vieuxtech@gmail.com>
jasnell pushed a commit that referenced this pull request Mar 7, 2017
doc: add comment for net.Server's error event
a98c1f6 
Fixes: #9710
PR-URL: #11136
Reviewed-By: Anna Henningsen <anna@addaleax.net>
Reviewed-By: James M Snell <jasnell@gmail.com>
Reviewed-By: Sam Roberts <vieuxtech@gmail.com>
MylesBorins pushed a commit that referenced this pull request Mar 9, 2017
doc: add comment for net.Server's error event
e0868aa 
Fixes: #9710
PR-URL: #11136
Reviewed-By: Anna Henningsen <anna@addaleax.net>
Reviewed-By: James M Snell <jasnell@gmail.com>
Reviewed-By: Sam Roberts <vieuxtech@gmail.com>
MylesBorins mentioned this pull request Mar 9, 2017
Merged
MylesBorins pushed a commit that referenced this pull request Mar 9, 2017
doc: add comment for net.Server's error event
6abfcd5 
Fixes: #9710
PR-URL: #11136
Reviewed-By: Anna Henningsen <anna@addaleax.net>
Reviewed-By: James M Snell <jasnell@gmail.com>
Reviewed-By: Sam Roberts <vieuxtech@gmail.com>
MylesBorins mentioned this pull request Mar 9, 2017
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

jasnell jasnell approved these changes
addaleax addaleax approved these changes
+1 more reviewer
sam-github sam-github approved these changes
Reviewers whose approvals may not affect merge requirements

Assignees

No one assigned

Labels

doc Issues and PRs related to the documentations. net Issues and PRs related to the net subsystem.

Projects

None yet

Milestone

No milestone

Development

Successfully merging this pull request may close these issues.

doc issue: socket server 'error' event: 'close' is not called as described in doc.

5 participants

Back | FazBrowse Home | New Git URL