Browse Source

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.

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>
v4.x
Vitor Cortez 9 years ago
committed by Myles Borins
parent
commit
5f4aa79410
  1. 24
      doc/api/stream.markdown

24
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][] There are base classes provided for [Readable][] streams, [Writable][]
streams, [Duplex][] streams, and [Transform][] streams. streams, [Duplex][] streams, and [Transform][] streams.
This document is split up into 3 sections. The first explains the This document is split up into 3 sections:
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 1. The first section explains the parts of the API that you need to be
stop there. aware of to use streams in your programs.
2. The second section explains the parts of the API that you need to
The second section explains the parts of the API that you need to use use if you implement your own custom streams yourself. The API is
if you implement your own custom streams yourself. The API is designed to make this easy for you to do.
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
The third section goes into more depth about how streams work, should probably not modify unless you definitely know what you are
including some of the internal mechanisms and functions that you doing.
should probably not modify unless you definitely know what you are
doing.
## API for Stream Consumers ## API for Stream Consumers

Loading…
Cancel
Save