This repository was archived by the owner on Apr 22, 2023. It is now read-only.
doc: several documentation improvements #25635
Closed
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Clarifies that emitter.listener() returns a copy, not a reference Resolves issue nodejs#9022
per: nodejs#14596 1. document that a runtime error will occur if you attempt to unshift after the end event 2. document that calling read after the end event will return null and will not trigger a runtime error
Minor clarifications around Readable._read and Readable.push to make their implementation/usage easier to understand. nodejs#14124 (comment)
Fix for nodejs#25559 (Typo in example of util.deprecate() documentation)
Per nodejs#14604, Document that performing an `unshift` during a read can have unexpected results. Following the `unshift` with a `push('')` resets the reading state appropriately. Also indicate that doing an `unshift` during a read is not optimal and should be avoided.
Member
Author
|
@joyent/node-collaborators |
doc/api/stream.markdown
Outdated
There was a problem hiding this comment.
Is this variable only for demonstration? Not being used.
Member
Author
There was a problem hiding this comment.
Ah...right, just mentally zoned on that one ;-). I'll remove the variable really quick
|
One question. Otherwise LGTM |
per nodejs#14597 Indicate that `'readable'` indicates only that data can be read from the stream, not that there is actually data to be consumed. `readable.read([size])` can still return null. Includes an example that illustrates the point.
jasnell
force-pushed
the
doc-improvements3
branch
from
1b9d4f3 to
970e2f1
Compare
doc/api/stream.markdown
Outdated
There was a problem hiding this comment.
The first two sentences are pretty confusing. Maybe:
The
'readable'event indicates that the stream has new information: either new data is available or the end of the stream has been reached. In the former case,.read()will return that data. In the latter case,.read()will returnnull. For instance, in the following example, ...
Member
Author
There was a problem hiding this comment.
@chrisdickinson ... done... if it looks good to you I'll get it landed
Per nodejs#25635 (comment) Additional refinement to the clarification on the `readable` event
jasnell
pushed a commit
that referenced
this pull request
Jul 10, 2015
Minor clarifications around Readable._read and Readable.push to make their implementation/usage easier to understand. #14124 (comment) Reviewed-By: James M Snell <jasnell@gmail.com> PR-URL: #25635
jasnell
added a commit
that referenced
this pull request
Jul 10, 2015
Per #14604, Document that performing an `unshift` during a read can have unexpected results. Following the `unshift` with a `push('')` resets the reading state appropriately. Also indicate that doing an `unshift` during a read is not optimal and should be avoided. Reviewed-By: James M Snell <jasnell@gmail.com> PR-URL: #25635
jasnell
added a commit
that referenced
this pull request
Jul 10, 2015
Per #25635 (comment) Additional refinement to the clarification on the `readable` event Reviewed-By: James M Snell <jasnell@gmail.com> PR-URL: #25635
jasnell
pushed a commit
to jasnell/node-joyent
that referenced
this pull request
Jul 10, 2015
Clarifies that emitter.listener() returns a copy, not a reference Resolves issue nodejs#9022 Reviewed-By: James M Snell <jasnell@gmail.com> PR-URL: nodejs#25635
jasnell
added a commit
to jasnell/node-joyent
that referenced
this pull request
Jul 10, 2015
per: nodejs#14596 1. document that a runtime error will occur if you attempt to unshift after the end event 2. document that calling read after the end event will return null and will not trigger a runtime error Reviewed-By: James M Snell <jasnell@gmail.com> PR-URL: nodejs#25635
jasnell
pushed a commit
to jasnell/node-joyent
that referenced
this pull request
Jul 10, 2015
Minor clarifications around Readable._read and Readable.push to make their implementation/usage easier to understand. nodejs#14124 (comment) Reviewed-By: James M Snell <jasnell@gmail.com> PR-URL: nodejs#25635
jasnell
pushed a commit
to jasnell/node-joyent
that referenced
this pull request
Jul 10, 2015
Fix for nodejs#25559 (Typo in example of util.deprecate() documentation) Reviewed-By: James M Snell <jasnell@gmail.com> PR-URL: nodejs#25635
jasnell
added a commit
to jasnell/node-joyent
that referenced
this pull request
Jul 10, 2015
Per nodejs#14604, Document that performing an `unshift` during a read can have unexpected results. Following the `unshift` with a `push('')` resets the reading state appropriately. Also indicate that doing an `unshift` during a read is not optimal and should be avoided. Reviewed-By: James M Snell <jasnell@gmail.com> PR-URL: nodejs#25635
jasnell
added a commit
to jasnell/node-joyent
that referenced
this pull request
Jul 10, 2015
per nodejs#14597 Indicate that `'readable'` indicates only that data can be read from the stream, not that there is actually data to be consumed. `readable.read([size])` can still return null. Includes an example that illustrates the point. Reviewed-By: James M Snell <jasnell@gmail.com> PR-URL: nodejs#25635
jasnell
added a commit
to jasnell/node-joyent
that referenced
this pull request
Jul 10, 2015
Per nodejs#25635 (comment) Additional refinement to the clarification on the `readable` event Reviewed-By: James M Snell <jasnell@gmail.com> PR-URL: nodejs#25635
jasnell
added a commit
that referenced
this pull request
Aug 4, 2015
Per #25635 (comment) Additional refinement to the clarification on the `readable` event Reviewed-By: James M Snell <jasnell@gmail.com> PR-URL: #25591
jasnell
added a commit
to jasnell/node
that referenced
this pull request
Aug 4, 2015
Per nodejs/node-v0.x-archive#25635 (comment) Additional refinement to the clarification on the `readable` event Reviewed-By: James M Snell <jasnell@gmail.com> PR-URL: nodejs/node-v0.x-archive#25591
jBarz
pushed a commit
to ibmruntimes/node
that referenced
this pull request
Nov 4, 2016
Per nodejs#25635 (comment) Additional refinement to the clarification on the `readable` event Reviewed-By: James M Snell <jasnell@gmail.com> PR-URL: nodejs#25591
Sign up for free
to subscribe to this conversation on GitHub.
Already have an account?
Sign in.
7 participants
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
bundled together to make landing them easier.