From 7ce445303706a79b58a0c7677ae9577ca0f0f4fa Mon Sep 17 00:00:00 2001
From: Robert Nagy <ronagy@icloud.com>
Date: Wed, 9 Oct 2019 08:45:00 +0200
Subject: [PATCH 1/8] doc: add notes about non-confirming streams

---
 doc/api/stream.md | 6 ++++++
 1 file changed, 6 insertions(+)

diff --git a/doc/api/stream.md b/doc/api/stream.md
index ca62df8169cf71..c71372e96cc047 100644
--- a/doc/api/stream.md
+++ b/doc/api/stream.md
@@ -1667,6 +1667,12 @@ of a stream that are intended for use by consumers (as described in the
 [API for Stream Consumers][] section). Doing so may lead to adverse side effects
 in application code consuming the stream.
 
+It is highly discouraged to override any public method. As well as emitting
+`'error'` events manually through `.emit(err)` instead of using API provided
+callbacks or `.destroy(err)`. Doing so can break current and future stream
+invariants leading to behaviour and/or compatibility issues with other streams,
+stream utilities and user expectations.
+
 ### Simplified Construction
 <!-- YAML
 added: v1.2.0

From e2207ebc41ad3194dafc4a4efecf3ed234e05699 Mon Sep 17 00:00:00 2001
From: Robert Nagy <ronagy@icloud.com>
Date: Sun, 20 Oct 2019 23:13:51 +0200
Subject: [PATCH 2/8] fixup

---
 doc/api/stream.md | 11 ++++++-----
 1 file changed, 6 insertions(+), 5 deletions(-)

diff --git a/doc/api/stream.md b/doc/api/stream.md
index c71372e96cc047..b17d0e4f44d1a2 100644
--- a/doc/api/stream.md
+++ b/doc/api/stream.md
@@ -1667,11 +1667,12 @@ of a stream that are intended for use by consumers (as described in the
 [API for Stream Consumers][] section). Doing so may lead to adverse side effects
 in application code consuming the stream.
 
-It is highly discouraged to override any public method. As well as emitting
-`'error'` events manually through `.emit(err)` instead of using API provided
-callbacks or `.destroy(err)`. Doing so can break current and future stream
-invariants leading to behaviour and/or compatibility issues with other streams,
-stream utilities and user expectations.
+It is highly discouraged to override any public method. As well as emitting any
+internal events such as `'error'`, `'data'`, `'end'`, `'finish'` and `'close'`
+manually through `.emit(err)` instead of using API provided callbacks or
+`.destroy(err)`. Doing so can break current and future stream invariants
+leading to behaviour and/or compatibility issues with other streams, stream
+utilities and user expectations.
 
 ### Simplified Construction
 <!-- YAML

From 1ac15d1720ba9246c0b28a15e53cb5ef6c373ef4 Mon Sep 17 00:00:00 2001
From: Robert Nagy <ronagy@icloud.com>
Date: Sun, 20 Oct 2019 23:15:03 +0200
Subject: [PATCH 3/8] fixup

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

diff --git a/doc/api/stream.md b/doc/api/stream.md
index b17d0e4f44d1a2..208f126f77f6c7 100644
--- a/doc/api/stream.md
+++ b/doc/api/stream.md
@@ -1667,11 +1667,11 @@ of a stream that are intended for use by consumers (as described in the
 [API for Stream Consumers][] section). Doing so may lead to adverse side effects
 in application code consuming the stream.
 
-It is highly discouraged to override any public method. As well as emitting any
-internal events such as `'error'`, `'data'`, `'end'`, `'finish'` and `'close'`
-manually through `.emit(err)` instead of using API provided callbacks or
+It is highly discouraged to override any public method or to emit any internal
+events such as `'error'`, `'data'`, `'end'`, `'finish'` and `'close'` manually
+through `.emit(err)` instead of using API provided callbacks or
 `.destroy(err)`. Doing so can break current and future stream invariants
-leading to behaviour and/or compatibility issues with other streams, stream
+leading to behavior and/or compatibility issues with other streams, stream
 utilities and user expectations.
 
 ### Simplified Construction

From fc5029df198b387c42a909d1576ae19a76714aac Mon Sep 17 00:00:00 2001
From: Robert Nagy <ronagy@icloud.com>
Date: Tue, 19 Nov 2019 16:16:50 +0100
Subject: [PATCH 4/8] Update doc/api/stream.md

Co-Authored-By: Ruben Bridgewater <ruben@bridgewater.de>
---
 doc/api/stream.md | 2 +-
 1 file changed, 1 insertion(+), 1 deletion(-)

diff --git a/doc/api/stream.md b/doc/api/stream.md
index 208f126f77f6c7..82ee716953246a 100644
--- a/doc/api/stream.md
+++ b/doc/api/stream.md
@@ -1669,7 +1669,7 @@ in application code consuming the stream.
 
 It is highly discouraged to override any public method or to emit any internal
 events such as `'error'`, `'data'`, `'end'`, `'finish'` and `'close'` manually
-through `.emit(err)` instead of using API provided callbacks or
+through `.emit(eventName)` instead of using API provided callbacks or
 `.destroy(err)`. Doing so can break current and future stream invariants
 leading to behavior and/or compatibility issues with other streams, stream
 utilities and user expectations.

From fdba619c45f2863df0e14b9771cc8989215ab905 Mon Sep 17 00:00:00 2001
From: Robert Nagy <ronagy@icloud.com>
Date: Sun, 24 Nov 2019 21:37:11 +0100
Subject: [PATCH 5/8] fixup: provide examples of methods

---
 doc/api/stream.md | 12 ++++++------
 1 file changed, 6 insertions(+), 6 deletions(-)

diff --git a/doc/api/stream.md b/doc/api/stream.md
index 82ee716953246a..b5d596d3b78801 100644
--- a/doc/api/stream.md
+++ b/doc/api/stream.md
@@ -1667,12 +1667,12 @@ of a stream that are intended for use by consumers (as described in the
 [API for Stream Consumers][] section). Doing so may lead to adverse side effects
 in application code consuming the stream.
 
-It is highly discouraged to override any public method or to emit any internal
-events such as `'error'`, `'data'`, `'end'`, `'finish'` and `'close'` manually
-through `.emit(eventName)` instead of using API provided callbacks or
-`.destroy(err)`. Doing so can break current and future stream invariants
-leading to behavior and/or compatibility issues with other streams, stream
-utilities and user expectations.
+It is highly discouraged to override any public method such as `write()`,
+`end()`, `cork()`, `uncork()`, `read()` and `destroy()`, or to emit any
+internal event such as `'error'`, `'data'`, `'end'`, `'finish'` and `'close'`
+manually through `.emit()`. Doing so can break current and future stream
+invariants leading to behavior and/or compatibility issues with other streams,
+stream utilities and user expectations.
 
 ### Simplified Construction
 <!-- YAML

From 6f4b7052f40da6cde6322219822c776bf2542a8c Mon Sep 17 00:00:00 2001
From: Robert Nagy <ronagy@icloud.com>
Date: Mon, 25 Nov 2019 09:16:54 +0100
Subject: [PATCH 6/8] Apply suggestions from code review

Co-Authored-By: Rich Trott <rtrott@gmail.com>
---
 doc/api/stream.md | 8 ++++----
 1 file changed, 4 insertions(+), 4 deletions(-)

diff --git a/doc/api/stream.md b/doc/api/stream.md
index b5d596d3b78801..d0f3d2d3db697b 100644
--- a/doc/api/stream.md
+++ b/doc/api/stream.md
@@ -1667,12 +1667,12 @@ of a stream that are intended for use by consumers (as described in the
 [API for Stream Consumers][] section). Doing so may lead to adverse side effects
 in application code consuming the stream.
 
-It is highly discouraged to override any public method such as `write()`,
-`end()`, `cork()`, `uncork()`, `read()` and `destroy()`, or to emit any
+Avoid overriding public methods such as `write()`,
+`end()`, `cork()`, `uncork()`, `read()` and `destroy()`, or emitting an
 internal event such as `'error'`, `'data'`, `'end'`, `'finish'` and `'close'`
-manually through `.emit()`. Doing so can break current and future stream
+through `.emit()`. Doing so can break current and future stream
 invariants leading to behavior and/or compatibility issues with other streams,
-stream utilities and user expectations.
+stream utilities, and user expectations.
 
 ### Simplified Construction
 <!-- YAML

From 50a3d5a714a0cb728ea9a48db1ad1b186320df00 Mon Sep 17 00:00:00 2001
From: Robert Nagy <ronagy@icloud.com>
Date: Mon, 25 Nov 2019 09:19:53 +0100
Subject: [PATCH 7/8] fixup: line wrap

---
 doc/api/stream.md | 12 ++++++------
 1 file changed, 6 insertions(+), 6 deletions(-)

diff --git a/doc/api/stream.md b/doc/api/stream.md
index d0f3d2d3db697b..b6299e13f1867a 100644
--- a/doc/api/stream.md
+++ b/doc/api/stream.md
@@ -1667,12 +1667,12 @@ of a stream that are intended for use by consumers (as described in the
 [API for Stream Consumers][] section). Doing so may lead to adverse side effects
 in application code consuming the stream.
 
-Avoid overriding public methods such as `write()`,
-`end()`, `cork()`, `uncork()`, `read()` and `destroy()`, or emitting an
-internal event such as `'error'`, `'data'`, `'end'`, `'finish'` and `'close'`
-through `.emit()`. Doing so can break current and future stream
-invariants leading to behavior and/or compatibility issues with other streams,
-stream utilities, and user expectations.
+Avoid overriding public methods such as `write()`, `end()`, `cork()`,
+`uncork()`, `read()` and `destroy()`, or emitting an internal event such
+as `'error'`, `'data'`, `'end'`, `'finish'` and `'close'` through `.emit()`.
+Doing so can break current and future stream invariants leading to behavior
+and/or compatibility issues with other streams, stream utilities, and user
+expectations.
 
 ### Simplified Construction
 <!-- YAML

From 687ead76610e83ef948e6e18631af8882b64df4d Mon Sep 17 00:00:00 2001
From: Robert Nagy <ronagy@icloud.com>
Date: Mon, 25 Nov 2019 09:20:18 +0100
Subject: [PATCH 8/8] fixup: events plural

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

diff --git a/doc/api/stream.md b/doc/api/stream.md
index b6299e13f1867a..800a4ccb17674e 100644
--- a/doc/api/stream.md
+++ b/doc/api/stream.md
@@ -1668,7 +1668,7 @@ of a stream that are intended for use by consumers (as described in the
 in application code consuming the stream.
 
 Avoid overriding public methods such as `write()`, `end()`, `cork()`,
-`uncork()`, `read()` and `destroy()`, or emitting an internal event such
+`uncork()`, `read()` and `destroy()`, or emitting internal events such
 as `'error'`, `'data'`, `'end'`, `'finish'` and `'close'` through `.emit()`.
 Doing so can break current and future stream invariants leading to behavior
 and/or compatibility issues with other streams, stream utilities, and user