diff options
| author | Alexey Orlenko <eaglexrlnk@gmail.com> | 2017-05-20 16:15:58 -0400 |
|---|---|---|
| committer | Refael Ackermann <refack@gmail.com> | 2017-05-25 18:49:41 -0400 |
| commit | 2af49b6c89dd4355ec0c1779fdb1fb12cf10e68d (patch) | |
| tree | d0ba4f62fff9db7d42b3f86c7358d9219b288698 /doc/api/net.md | |
| parent | b3d1e3d4c720729c8f14e413a285660547ee677a (diff) | |
| download | android-node-v8-2af49b6c89dd4355ec0c1779fdb1fb12cf10e68d.tar.gz android-node-v8-2af49b6c89dd4355ec0c1779fdb1fb12cf10e68d.tar.bz2 android-node-v8-2af49b6c89dd4355ec0c1779fdb1fb12cf10e68d.zip | |
doc: make the style of notes consistent
Make the style of "Note:" paragraphs consistent and document the
guidelines in `doc/STYLE_GUIDE.md`.
PR-URL: https://github.com/nodejs/node/pull/13133
Fixes: https://github.com/nodejs/node/issues/13131
Reviewed-By: Refael Ackermann <refack@gmail.com>
Reviewed-By: Luigi Pinca <luigipinca@gmail.com>
Reviewed-By: Daijiro Wachi <daijiro.wachi@gmail.com>
Reviewed-By: Michael Dawson <michael_dawson@ca.ibm.com>
Reviewed-By: James M Snell <jasnell@gmail.com>
Reviewed-By: Sam Roberts <vieuxtech@gmail.com>
Diffstat (limited to 'doc/api/net.md')
| -rw-r--r-- | doc/api/net.md | 7 |
1 files changed, 4 insertions, 3 deletions
diff --git a/doc/api/net.md b/doc/api/net.md index 8eea2d4bcd..982a5a0aeb 100644 --- a/doc/api/net.md +++ b/doc/api/net.md @@ -185,10 +185,11 @@ by the OS through sysctl settings such as `tcp_max_syn_backlog` and `somaxconn` on Linux. The default value of this parameter is 511 (not 512). -Note: +*Note*: * All [`net.Socket`][] are set to `SO_REUSEADDR` (See [socket(7)][] for details). + * The `server.listen()` method may be called multiple times. Each subsequent call will *re-open* the server using the provided options. @@ -294,7 +295,7 @@ If `host` is omitted, the server will accept connections on the [unspecified IPv6 address][] (`::`) when IPv6 is available, or the [unspecified IPv4 address][] (`0.0.0.0`) otherwise. -*Note*: in most operating systems, listening to the +*Note*: In most operating systems, listening to the [unspecified IPv6 address][] (`::`) may cause the `net.Server` to also listen on the [unspecified IPv4 address][] (`0.0.0.0`). @@ -852,7 +853,7 @@ Possible signatures: * [`net.createConnection(port[, host][, connectListener])`][`net.createConnection(port, host)`] for TCP connections. -*Note*: the [`net.connect()`][] function is an alias to this function. +*Note*: The [`net.connect()`][] function is an alias to this function. ### net.createConnection(options[, connectListener]) <!-- YAML |