Skip to content

Commit

Permalink
doc: improve doc net:server.listen
Browse files Browse the repository at this point in the history
Remove line "Common parameter of server.listen() functions."
from net:server.listen callback functions because there is no
need of this line.

PR-URL: #31064
Fixes: #31019
Reviewed-By: Gireesh Punathil <gpunathi@in.ibm.com>
Reviewed-By: Colin Ihrig <cjihrig@gmail.com>
Reviewed-By: James M Snell <jasnell@gmail.com>
Reviewed-By: Ruben Bridgewater <ruben@bridgewater.de>
  • Loading branch information
dev-script authored and BethGriggs committed Feb 6, 2020
1 parent c732564 commit f099494
Showing 1 changed file with 4 additions and 4 deletions.
8 changes: 4 additions & 4 deletions doc/api/net.md
Expand Up @@ -241,7 +241,7 @@ added: v0.5.10

* `handle` {Object}
* `backlog` {number} Common parameter of [`server.listen()`][] functions
* `callback` {Function} Common parameter of [`server.listen()`][] functions
* `callback` {Function}
* Returns: {net.Server}

Start a server listening for connections on a given `handle` that has
Expand Down Expand Up @@ -277,7 +277,7 @@ changes:
* `ipv6Only` {boolean} For TCP servers, setting `ipv6Only` to `true` will
disable dual-stack support, i.e., binding to host `::` won't make
`0.0.0.0` be bound. **Default:** `false`.
* `callback` {Function} Common parameter of [`server.listen()`][]
* `callback` {Function}
functions.
* Returns: {net.Server}

Expand Down Expand Up @@ -314,7 +314,7 @@ added: v0.1.90
* `path` {string} Path the server should listen to. See
[Identifying paths for IPC connections][].
* `backlog` {number} Common parameter of [`server.listen()`][] functions.
* `callback` {Function} Common parameter of [`server.listen()`][] functions.
* `callback` {Function}.
* Returns: {net.Server}

Start an [IPC][] server listening for connections on the given `path`.
Expand All @@ -327,7 +327,7 @@ added: v0.1.90
* `port` {number}
* `host` {string}
* `backlog` {number} Common parameter of [`server.listen()`][] functions.
* `callback` {Function} Common parameter of [`server.listen()`][] functions.
* `callback` {Function}.
* Returns: {net.Server}

Start a TCP server listening for connections on the given `port` and `host`.
Expand Down

0 comments on commit f099494

Please sign in to comment.