Skip to content

Navigation Menu

Sign in
Appearance settings

Search code, repositories, users, issues, pull requests...

Provide feedback

We read every piece of feedback, and take your input very seriously.

Saved searches

Use saved searches to filter your results more quickly

Appearance settings

Commit 3470574

Browse filesBrowse files
vccortezjasnell
authored andcommitted
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: #4234 Reviewed-By: James M Snell <jasnell@gmail.com>
1 parent 8182ec0 commit 3470574
Copy full SHA for 3470574

File tree

Expand file treeCollapse file tree

1 file changed

+11
-13
lines changed
Open diff view settings
Filter options
Expand file treeCollapse file tree

1 file changed

+11
-13
lines changed
Open diff view settings
Collapse file

‎doc/api/stream.markdown‎

Copy file name to clipboardExpand all lines: doc/api/stream.markdown
+11-13Lines changed: 11 additions & 13 deletions
  • Display the source diff
  • Display the rich diff
Original file line numberDiff line numberDiff line change
@@ -11,19 +11,17 @@ You can load the Stream base classes by doing `require('stream')`.
1111
There are base classes provided for [Readable][] streams, [Writable][]
1212
streams, [Duplex][] streams, and [Transform][] streams.
1313

14-
This document is split up into 3 sections. The first explains the
15-
parts of the API that you need to be aware of to use streams in your
16-
programs. If you never implement a streaming API yourself, you can
17-
stop there.
18-
19-
The second section explains the parts of the API that you need to use
20-
if you implement your own custom streams yourself. The API is
21-
designed to make this easy for you to do.
22-
23-
The third section goes into more depth about how streams work,
24-
including some of the internal mechanisms and functions that you
25-
should probably not modify unless you definitely know what you are
26-
doing.
14+
This document is split up into 3 sections:
15+
16+
1. The first section explains the parts of the API that you need to be
17+
aware of to use streams in your programs.
18+
2. The second section explains the parts of the API that you need to
19+
use if you implement your own custom streams yourself. The API is
20+
designed to make this easy for you to do.
21+
3. The third section goes into more depth about how streams work,
22+
including some of the internal mechanisms and functions that you
23+
should probably not modify unless you definitely know what you are
24+
doing.
2725

2826

2927
## API for Stream Consumers

0 commit comments

Comments
0 (0)
Morty Proxy This is a proxified and sanitized view of the page, visit original site.