doc: add comment for net.Server's error event #11136
Conversation
nodejs-github-bot
added
doc
There was a problem hiding this comment.
Looks good, with a small nit.
Two things regarding the commit message though:
-
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.
-
Could you use
Fixes:instead ofFix:? 😄 It’s not important, but the former is more commonly used around here.
doc/api/net.md
Outdated
| @@ -40,8 +40,9 @@ added: v0.1.90 | |||
|
|
|||
| * {Error} | |||
|
|
|||
| Emitted when an error occurs. The [`'close'`][] event will be called directly | |||
| following this event. See example in discussion of `server.listen`. | |||
| Emitted when an error occurs. Unlike the [`net.Socket`][], the [`'close'`][] | |||
There was a problem hiding this comment.
Can you drop the, or replace it with with? (not a native speaker myself but the the sounds odd here)
There was a problem hiding this comment.
Of course, thank you!
jjqq2013
force-pushed
the
doc-server-error
branch
2 times, most recently
from
ef32fb1 to
5cbd17a
Compare
doc/api/net.md
Outdated
| following this event. See example in discussion of `server.listen`. | ||
| Emitted when an error occurs. Unlike [`net.Socket`][], the [`'close'`][] | ||
| event will NOT be called directly following this event, unless you call | ||
| `server.close()` manually. See example in discussion of `server.listen`. |
There was a problem hiding this comment.
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()`.
There was a problem hiding this comment.
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
|
The |
doc/api/net.md
Outdated
| Emitted when an error occurs. The [`'close'`][] event will be called directly | ||
| following this event. See example in discussion of `server.listen`. | ||
| Emitted when an error occurs. Unlike [`net.Socket`][], the [`'close'`][] | ||
| event will **not** be called directly following this event unless |
There was a problem hiding this comment.
events are "emitted", not "called"
There was a problem hiding this comment.
ok, i will correct it and the original description.
Yes. |
|
sorry, i found the
So i think no need to add description of |
doc/api/net.md
Outdated
| Emitted when an error occurs. Unlike [`net.Socket`][], the [`'close'`][] | ||
| event will **not** be emitted directly following this event unless | ||
| `server.close()` is manually called. See the example in discussion of | ||
| `server.listen()`. |
There was a problem hiding this comment.
would be good to link server.close() and server.listen()
There was a problem hiding this comment.
@QianJin2013 ... please see @sam-github's comment above :-)
There was a problem hiding this comment.
@sam-github I'd tried to link server.close() and server.listen() but failed. Now i know the reason, i have modified doc again.
|
you'll need to squash and rebase |
|
@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
jjqq2013
force-pushed
the
doc-server-error
branch
from
72b4bd3 to
3dc2a1d
Compare
|
Landed in 52ddb41. thanks. |
Fix: #9710
Checklist
Affected core subsystem(s)
doc