Skip to content
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

doc: fix typos in the stream doc #7336

Closed
wants to merge 7 commits into from
Closed

doc: fix typos in the stream doc #7336

Changes from 4 commits
Commits
Show all changes
7 commits
Select commit Hold shift + click to select a range
228ca98
doc: fix typo in the stream doc
vsemozhetbyt Jun 18, 2016
c12b0a1
doc: delete typo semicolon in the code example
vsemozhetbyt Jun 18, 2016
bcea209
Fix more typos in links
vsemozhetbyt Jun 19, 2016
2dddbe6
Refix a typo in the link
vsemozhetbyt Jun 19, 2016
5a110e0
Rerefix a typo in the link
vsemozhetbyt Jun 19, 2016
ff96afe
Remove typo backslashes from dot member access
vsemozhetbyt Jun 19, 2016
705c752
Restore backslashes in headers
vsemozhetbyt Jun 19, 2016
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
10 changes: 5 additions & 5 deletions doc/api/stream.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -38,7 +38,7 @@ There are four fundamental stream types within Node.js:
* [Readable][] - streams from which data can be read (for example
[`fs.createReadStream()`][]).
* [Writable][] - streams to which data can be written (for example
[`fs.createWriteStream`][]).
[`fs.createWriteStream()`][]).
* [Duplex][] - streams that are both Readable and Writable (for example
[`net.Socket`][]).
* [Transform][] - Duplex streams that can modify or transform the data as it
Expand Down Expand Up @@ -786,7 +786,7 @@ following example:

```js
getReadableStreamSomehow()
.resume();
.resume()
.on('end', () => {
console.log('Reached the end, but did not read anything.');
});
Expand Down Expand Up @@ -1161,7 +1161,7 @@ All Writable stream implementations must provide a
resource.

*Note*: [Transform][] streams provide their own implementation of the
[`writable._write()`].
[`writable._write()`][stream-_write].

*Note*: **This function MUST NOT be called by application code directly.** It
should be implemented by child classes, and called only by the internal Writable
Expand Down Expand Up @@ -1632,7 +1632,7 @@ The `stream.Transform` class prototypically inherits from `stream.Duplex` and
implements its own versions of the `writable.\_write()` and `readable.\_read()`
methods. Custom Transform implementations *must* implement the
[`transform.\_transform()`][stream-_transform] method and *may* also implement
the [`transform.\_flush()`][stream-._flush] method.
the [`transform.\_flush()`][stream-_flush] method.

*Note*: Care must be taken when using Transform streams in that data written
to the stream can cause the Writable side of the stream to become paused if
Expand Down Expand Up @@ -1848,7 +1848,7 @@ net.createServer((socket) => {

In addition to new Readable streams switching into flowing mode,
pre-v0.10 style streams can be wrapped in a Readable class using the
[`readable.wrap()`][] method.
[`readable.wrap()`][stream-_wrap] method.
Copy link
Member

@addaleax addaleax Jun 19, 2016 •
edited
Loading

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This should be [readable.wrap()][stream.wrap()]?

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

There should be the backticks in the second brackets too?

Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

In the footer of the file, there is a [stream.wrap()]: #stream_readable_wrap_stream line, so yes, I think so



### `readable.read(0)`
Expand Down