This repository has been archived by the owner on Apr 22, 2023. It is now read-only.
doc: several additional bundled doc improvements #25592
Closed
Conversation
This file contains 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
'the' to 'then'
Made explicitely clear that when size bytes are not available, it will return null, unless we've ended, in which case the data remaining in the buffer will be returned. Fixes nodejs#7273
This was referenced Jun 29, 2015
| @@ -227,7 +227,9 @@ returns it. If there is no data available, then it will return | |||
| `null`. | |||
|
|
|||
| If you pass in a `size` argument, then it will return that many | |||
| bytes. If `size` bytes are not available, then it will return `null`. | |||
| bytes. If `size` bytes are not available, then it will return `null`, | |||
| unless we've ended, in which case it will return the data remaining | |||
There was a problem hiding this comment.
Instead of "we've" maybe this should say "the stream".
|
LGTM with one tiny suggestion. |
jasnell
pushed a commit
that referenced
this pull request
Jun 29, 2015
Reviewed-By: James M Snell <jasnell@gmail.com> PR-URL: #25592
jasnell
pushed a commit
that referenced
this pull request
Jun 29, 2015
Reviewed-By: James M Snell <jasnell@gmail.com> PR-URL: #25592
jasnell
pushed a commit
that referenced
this pull request
Jun 29, 2015
Reviewed-By: James M Snell <jasnell@gmail.com> PR-URL: #25592
jasnell
pushed a commit
that referenced
this pull request
Jun 29, 2015
'the' to 'then' Reviewed-By: James M Snell <jasnell@gmail.com> PR-URL: #25592
|
Landed |
jasnell
pushed a commit
to jasnell/node-joyent
that referenced
this pull request
Jul 9, 2015
Reviewed-By: James M Snell <jasnell@gmail.com> PR-URL: nodejs#25592
jasnell
pushed a commit
to jasnell/node-joyent
that referenced
this pull request
Jul 9, 2015
Reviewed-By: James M Snell <jasnell@gmail.com> PR-URL: nodejs#25592
jasnell
pushed a commit
to jasnell/node-joyent
that referenced
this pull request
Jul 9, 2015
Reviewed-By: James M Snell <jasnell@gmail.com> PR-URL: nodejs#25592
jasnell
pushed a commit
to jasnell/node-joyent
that referenced
this pull request
Jul 9, 2015
'the' to 'then' Reviewed-By: James M Snell <jasnell@gmail.com> PR-URL: nodejs#25592
jasnell
pushed a commit
to jasnell/node-joyent
that referenced
this pull request
Jul 9, 2015
Made explicitely clear that when size bytes are not available, it will return null, unless we've ended, in which case the data remaining in the buffer will be returned. Fixes nodejs#7273 Reviewed-By: James M Snell <jasnell@gmail.com> PR-URL: nodejs#25592
Sign up for free
to subscribe to this conversation on GitHub.
Already have an account?
Sign in.
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.
A second round of documentation improvements from other individual pull requests,
bundled to make them easier to land. Each of the original PR's were already reviewed
and signed off.