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

[jjqq2013]

Fix: #9710

Checklist

• documentation is changed or added
• commit message follows commit guidelines

Affected core subsystem(s)

doc

[addaleax]

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.

[addaleax]

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

[jjqq2013]

Of course, thank you!

[jasnell]

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]

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]

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]

events are "emitted", not "called"

[jjqq2013]

ok, i will correct it and the original description.

[sam-github]

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]

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]

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

[jasnell]

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

[jjqq2013]

@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]

you'll need to squash and rebase

[jjqq2013]

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

[sam-github]

Landed in 52ddb41. thanks.