From d333b0a8656b7b3aaf17bc66c1cd4b9ccf375a13 Mon Sep 17 00:00:00 2001 From: Vitor Cortez Date: Thu, 10 Dec 2015 18:32:13 -0300 Subject: [PATCH 1/2] doc: clarify explanation of first stream section The last sentence of the explanation for the first stream section seemed a bit confusing. I tried to change the sentence to clarify it. --- doc/api/stream.markdown | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/doc/api/stream.markdown b/doc/api/stream.markdown index b76ef0093e1847..2bdea056444bb7 100644 --- a/doc/api/stream.markdown +++ b/doc/api/stream.markdown @@ -13,8 +13,8 @@ streams, [Duplex][] streams, and [Transform][] streams. This document is split up into 3 sections. The first explains the parts of the API that you need to be aware of to use streams in your -programs. If you never implement a streaming API yourself, you can -stop there. +programs. If you never intend to implement a streaming API yourself, +you can stop there. The second section explains the parts of the API that you need to use if you implement your own custom streams yourself. The API is From ff3b458c9d0aa48f8afa009159fe9761cce62cee Mon Sep 17 00:00:00 2001 From: Vitor Cortez Date: Mon, 14 Dec 2015 13:25:31 -0300 Subject: [PATCH 2/2] doc: clarify stream section and add numbered list The last sentence explaining the first stream section was removed as it didn't add much value to the explanation. Additionally, the sections were turned into a numbered list to be more clear about which section is being described, and improve readability. --- doc/api/stream.markdown | 24 +++++++++++------------- 1 file changed, 11 insertions(+), 13 deletions(-) diff --git a/doc/api/stream.markdown b/doc/api/stream.markdown index 2bdea056444bb7..bbb70b1f748687 100644 --- a/doc/api/stream.markdown +++ b/doc/api/stream.markdown @@ -11,19 +11,17 @@ You can load the Stream base classes by doing `require('stream')`. There are base classes provided for [Readable][] streams, [Writable][] streams, [Duplex][] streams, and [Transform][] streams. -This document is split up into 3 sections. The first explains the -parts of the API that you need to be aware of to use streams in your -programs. If you never intend to implement a streaming API yourself, -you can stop there. - -The second section explains the parts of the API that you need to use -if you implement your own custom streams yourself. The API is -designed to make this easy for you to do. - -The third section goes into more depth about how streams work, -including some of the internal mechanisms and functions that you -should probably not modify unless you definitely know what you are -doing. +This document is split up into 3 sections: + +1. The first section explains the parts of the API that you need to be + aware of to use streams in your programs. +2. The second section explains the parts of the API that you need to + use if you implement your own custom streams yourself. The API is + designed to make this easy for you to do. +3. The third section goes into more depth about how streams work, + including some of the internal mechanisms and functions that you + should probably not modify unless you definitely know what you are + doing. ## API for Stream Consumers