doc: clarify explanation of first stream section
authorVitor Cortez <vitoracortez+github@gmail.com>
Thu, 10 Dec 2015 21:32:13 +0000 (18:32 -0300)
committerMyles Borins <mborins@us.ibm.com>
Tue, 19 Jan 2016 19:52:40 +0000 (11:52 -0800)
The last sentence of the explanation for the first stream section
seemed a bit confusing. I tried to change the sentence to clarify it.

Additionally, the sections were turned into a numbered list to be more
clear about which section is being described, and improve readability.

PR-URL: https://github.com/nodejs/node/pull/4234
Reviewed-By: James M Snell <jasnell@gmail.com>
doc/api/stream.markdown

index 76d9623..a0fcb81 100644 (file)
@@ -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 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