From 2af49b6c89dd4355ec0c1779fdb1fb12cf10e68d Mon Sep 17 00:00:00 2001 From: Alexey Orlenko Date: Sat, 20 May 2017 16:15:58 -0400 Subject: 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 Reviewed-By: Luigi Pinca Reviewed-By: Daijiro Wachi Reviewed-By: Michael Dawson Reviewed-By: James M Snell Reviewed-By: Sam Roberts --- doc/api/net.md | 7 ++++--- 1 file changed, 4 insertions(+), 3 deletions(-) (limited to 'doc/api/net.md') 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])