Skip to content

doc: clarify explanation of first stream section #4234

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Closed
vccortez wants to merge 2 commits into from
Closed

doc: clarify explanation of first stream section #4234

Changes from 1 commit
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
d333b0a
doc: clarify explanation of first stream section
vccortez Dec 10, 2015
ff3b458
doc: clarify stream section and add numbered list
vccortez Dec 14, 2015
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
Prev Previous commit
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.
  • Loading branch information
@vccortez
vccortez committed Dec 14, 2015
commit ff3b458c9d0aa48f8afa009159fe9761cce62cee
24 changes: 11 additions & 13 deletions doc/api/stream.markdown
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down