From 9f258a4a83d992e7f7ca4a998515661638436e81 Mon Sep 17 00:00:00 2001
From: Rusty Conover <rusty@conover.me>
Date: Mon, 27 Jan 2020 14:16:11 -0500
Subject: [PATCH 1/5] docs: Reword socket.setNoDelay()

Change the description of socket.setNoDelay() to make it clear
that sockets have Nagle's algorithm enabled by default.

Better document the tradeoff of having the algorithm enabled.

Explain the behavior of the function based on the passed arguments.
---
 doc/api/net.md | 13 ++++++++++---
 1 file changed, 10 insertions(+), 3 deletions(-)

diff --git a/doc/api/net.md b/doc/api/net.md
index d04e7eff0789a7..b3a0820dc55f6a 100644
--- a/doc/api/net.md
+++ b/doc/api/net.md
@@ -879,9 +879,16 @@ added: v0.1.90
 * `noDelay` {boolean} **Default:** `true`
 * Returns: {net.Socket} The socket itself.
 
-Disables the Nagle algorithm. By default TCP connections use the Nagle
-algorithm, they buffer data before sending it off. Setting `true` for
-`noDelay` will immediately fire off data each time `socket.write()` is called.
+Enable/disable the Nagle algorithm.
+
+TCP connections when they are created have the Nagle algorithm enabled.
+
+The Nagle algorithm delays data before it is sent via the network. It attempts
+to optimize throughput at the expense of latency.
+
+Setting `true` for `noDelay` or not passing an argument will disable the Nagle
+algorithm for the socket. Setting `false` for `noDelay` will enable the Nagle
+algorithm.
 
 ### `socket.setTimeout(timeout[, callback])`
 <!-- YAML

From b7d4d9883b9850af324d224b26b89e29ea4fc383 Mon Sep 17 00:00:00 2001
From: Rusty Conover <rusty@conover.me>
Date: Mon, 27 Jan 2020 14:32:03 -0500
Subject: [PATCH 2/5] Change setting to passing.

---
 doc/api/net.md | 4 ++--
 1 file changed, 2 insertions(+), 2 deletions(-)

diff --git a/doc/api/net.md b/doc/api/net.md
index b3a0820dc55f6a..2c8949f9e5f46c 100644
--- a/doc/api/net.md
+++ b/doc/api/net.md
@@ -886,8 +886,8 @@ TCP connections when they are created have the Nagle algorithm enabled.
 The Nagle algorithm delays data before it is sent via the network. It attempts
 to optimize throughput at the expense of latency.
 
-Setting `true` for `noDelay` or not passing an argument will disable the Nagle
-algorithm for the socket. Setting `false` for `noDelay` will enable the Nagle
+Passing `true` for `noDelay` or not passing an argument will disable the Nagle
+algorithm for the socket. Passing `false` for `noDelay` will enable the Nagle
 algorithm.
 
 ### `socket.setTimeout(timeout[, callback])`

From f19ff9b251fd09828f0715a37fa5d5115c1a45e2 Mon Sep 17 00:00:00 2001
From: Rusty Conover <rusty@conover.me>
Date: Mon, 27 Jan 2020 17:19:30 -0500
Subject: [PATCH 3/5] Reword following suggestion.

---
 doc/api/net.md | 2 +-
 1 file changed, 1 insertion(+), 1 deletion(-)

diff --git a/doc/api/net.md b/doc/api/net.md
index 2c8949f9e5f46c..c335fee6d91ec3 100644
--- a/doc/api/net.md
+++ b/doc/api/net.md
@@ -881,7 +881,7 @@ added: v0.1.90
 
 Enable/disable the Nagle algorithm.
 
-TCP connections when they are created have the Nagle algorithm enabled.
+When TCP connections are created have the Nagle algorithm enabled.
 
 The Nagle algorithm delays data before it is sent via the network. It attempts
 to optimize throughput at the expense of latency.

From c2e7d2e75c93da45fec52168086bc5e715cbbcd5 Mon Sep 17 00:00:00 2001
From: Rusty Conover <rusty@conover.me>
Date: Tue, 28 Jan 2020 08:38:41 -0500
Subject: [PATCH 4/5] Rewording and making text more clear.

---
 doc/api/net.md | 10 +++++-----
 1 file changed, 5 insertions(+), 5 deletions(-)

diff --git a/doc/api/net.md b/doc/api/net.md
index c335fee6d91ec3..95fc994c509c7f 100644
--- a/doc/api/net.md
+++ b/doc/api/net.md
@@ -879,15 +879,15 @@ added: v0.1.90
 * `noDelay` {boolean} **Default:** `true`
 * Returns: {net.Socket} The socket itself.
 
-Enable/disable the Nagle algorithm.
+Enable/disable the use of Nagle's algorithm.
 
-When TCP connections are created have the Nagle algorithm enabled.
+When a TCP connection is created it will have Nagle's algorithm enabled.
 
-The Nagle algorithm delays data before it is sent via the network. It attempts
+Nagle's algorithm delays data before it is sent via the network. It attempts
 to optimize throughput at the expense of latency.
 
-Passing `true` for `noDelay` or not passing an argument will disable the Nagle
-algorithm for the socket. Passing `false` for `noDelay` will enable the Nagle
+Passing `true` for `noDelay` or not passing an argument will disable Nagle's
+algorithm for the socket. Passing `false` for `noDelay` will enable Nagle's
 algorithm.
 
 ### `socket.setTimeout(timeout[, callback])`

From a3a01fc08b60faff85d088f78359433230ca3dbb Mon Sep 17 00:00:00 2001
From: Rusty Conover <rusty@conover.me>
Date: Wed, 29 Jan 2020 12:11:13 -0500
Subject: [PATCH 5/5] Add comma

---
 doc/api/net.md | 2 +-
 1 file changed, 1 insertion(+), 1 deletion(-)

diff --git a/doc/api/net.md b/doc/api/net.md
index 95fc994c509c7f..bb5a55e0e48f78 100644
--- a/doc/api/net.md
+++ b/doc/api/net.md
@@ -881,7 +881,7 @@ added: v0.1.90
 
 Enable/disable the use of Nagle's algorithm.
 
-When a TCP connection is created it will have Nagle's algorithm enabled.
+When a TCP connection is created, it will have Nagle's algorithm enabled.
 
 Nagle's algorithm delays data before it is sent via the network. It attempts
 to optimize throughput at the expense of latency.