summaryrefslogtreecommitdiff
path: root/doc/api/net.md
diff options
context:
space:
mode:
authorJames M Snell <jasnell@gmail.com>2018-02-05 21:55:16 -0800
committerAnatoli Papirovski <apapirovski@mac.com>2018-02-08 11:57:14 -0500
commitd3569b623ccd593c9ef62fcaf0aba2711dc7fbfa (patch)
tree643d44f1eb33c9b822fea7742d2691355d295a4c /doc/api/net.md
parent809af1fe8a0a096be4f0a3020f8e60ee1c827cbc (diff)
downloadandroid-node-v8-d3569b623ccd593c9ef62fcaf0aba2711dc7fbfa.tar.gz
android-node-v8-d3569b623ccd593c9ef62fcaf0aba2711dc7fbfa.tar.bz2
android-node-v8-d3569b623ccd593c9ef62fcaf0aba2711dc7fbfa.zip
doc: remove **Note:** tags
Remove the various **Note:** prefixes throughout the docs. PR-URL: https://github.com/nodejs/node/pull/18592 Reviewed-By: Rich Trott <rtrott@gmail.com> Reviewed-By: Daniel Bevenius <daniel.bevenius@gmail.com> Reviewed-By: Colin Ihrig <cjihrig@gmail.com> Reviewed-By: Ruben Bridgewater <ruben@bridgewater.de> Reviewed-By: Michael Dawson <michael_dawson@ca.ibm.com>
Diffstat (limited to 'doc/api/net.md')
-rw-r--r--doc/api/net.md21
1 files changed, 9 insertions, 12 deletions
diff --git a/doc/api/net.md b/doc/api/net.md
index b213829ffd..6e2b7386b3 100644
--- a/doc/api/net.md
+++ b/doc/api/net.md
@@ -194,14 +194,11 @@ length of the queue of pending connections. The actual length will be determined
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).
+All [`net.Socket`][] are set to `SO_REUSEADDR` (See [socket(7)][] for details).
-*Note*:
-
-* All [`net.Socket`][] are set to `SO_REUSEADDR` (See [socket(7)][] for
- details).
-* The `server.listen()` method can be called again if and only if there was an error
- during the first `server.listen()` call or `server.close()` has been called.
- Otherwise, an `ERR_SERVER_ALREADY_LISTEN` error will be thrown.
+The `server.listen()` method can be called again if and only if there was an error
+during the first `server.listen()` call or `server.close()` has been called.
+Otherwise, an `ERR_SERVER_ALREADY_LISTEN` error will be thrown.
One of the most common errors raised when listening is `EADDRINUSE`.
This happens when another server is already listening on the requested
@@ -237,7 +234,7 @@ The `handle` object can be either a server, a socket (anything with an
underlying `_handle` member), or an object with an `fd` member that is a
valid file descriptor.
-*Note*: Listening on a file descriptor is not supported on Windows.
+Listening on a file descriptor is not supported on Windows.
#### server.listen(options[, callback])
<!-- YAML
@@ -309,9 +306,9 @@ 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
-[unspecified IPv6 address][] (`::`) may cause the `net.Server` to also listen on
-the [unspecified IPv4 address][] (`0.0.0.0`).
+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`).
### server.listening
<!-- YAML
@@ -885,7 +882,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.
+The [`net.connect()`][] function is an alias to this function.
### net.createConnection(options[, connectListener])
<!-- YAML