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.

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: Updated streams simplified constructor API #3602

Closed
wants to merge 1 commit into from

Conversation

Projects
None yet
6 participants
@tomgco
Copy link
Contributor

commented Oct 30, 2015

The examples for implementing the simplified constructor API was missing some details on its correct usages.

I have updated them to reflect this.

@trevnorris

View changes

doc/api/stream.markdown Outdated
@@ -1384,6 +1388,9 @@ var readable = new stream.Readable({
var writable = new stream.Writable({
write: function(chunk, encoding, next) {
// sets this._write under the hood

// Optionally with an error

This comment has been minimized.

Copy link
@trevnorris

trevnorris Nov 2, 2015

Contributor

you mean an error can be optionally passed?

This comment has been minimized.

Copy link
@tomgco

tomgco Nov 3, 2015

Author Contributor

Yes, that would sound more concise, will update.

@tomgco tomgco force-pushed the tomgco:streams-docs branch to a3ecda7 Nov 6, 2015

@tomgco

This comment has been minimized.

Copy link
Contributor Author

commented Nov 6, 2015

@trevnorris I have addressed your comments and updated the PR

@trevnorris

This comment has been minimized.

Copy link
Contributor

commented Nov 6, 2015

Thanks much.

Anyone from @nodejs/documentation or such mind weighing in?

@chrisdickinson

This comment has been minimized.

Copy link
Contributor

commented Nov 7, 2015

LGTM!

On Nov 6, 2015, at 7:46 AM, Trevor Norris notifications@github.com wrote:

Thanks much.

Anyone from @nodejs/documentation or such mind weighing in?


Reply to this email directly or view it on GitHub.

@jasnell

This comment has been minimized.

Copy link
Member

commented Nov 13, 2015

LGTM. There are some merge conflicts due to the doc being restructured. I'll fix those up on landing tho.

jasnell added a commit that referenced this pull request Nov 13, 2015

doc: Updated streams simplified constructor API
The examples for implementing the simplified constructor API
was missing some details on its correct usages.

PR-URL: #3602
Reviewed-By: James M Snell <jasnell@gmail.com>
Reviewed-By: Chris Dickinson <chris@neversaw.us>
@jasnell

This comment has been minimized.

Copy link
Member

commented Nov 13, 2015

Landed in 4270e7f

@jasnell jasnell closed this Nov 13, 2015

MylesBorins added a commit that referenced this pull request Nov 16, 2015

doc: Updated streams simplified constructor API
The examples for implementing the simplified constructor API
was missing some details on its correct usages.

PR-URL: #3602
Reviewed-By: James M Snell <jasnell@gmail.com>
Reviewed-By: Chris Dickinson <chris@neversaw.us>
@MylesBorins

This comment has been minimized.

Copy link
Member

commented Nov 16, 2015

landed in v4.x-staging as bb20abb

@rvagg rvagg referenced this pull request Nov 17, 2015

Closed

v4.2.2+1 commit candidates #57

Fishrock123 added a commit that referenced this pull request Nov 17, 2015

doc: Updated streams simplified constructor API
The examples for implementing the simplified constructor API
was missing some details on its correct usages.

PR-URL: #3602
Reviewed-By: James M Snell <jasnell@gmail.com>
Reviewed-By: Chris Dickinson <chris@neversaw.us>

rvagg added a commit that referenced this pull request Dec 4, 2015

doc: Updated streams simplified constructor API
The examples for implementing the simplified constructor API
was missing some details on its correct usages.

PR-URL: #3602
Reviewed-By: James M Snell <jasnell@gmail.com>
Reviewed-By: Chris Dickinson <chris@neversaw.us>

@jasnell jasnell referenced this pull request Dec 17, 2015

Closed

Release 4.2.4 Planning #4321

jasnell added a commit that referenced this pull request Dec 17, 2015

doc: Updated streams simplified constructor API
The examples for implementing the simplified constructor API
was missing some details on its correct usages.

PR-URL: #3602
Reviewed-By: James M Snell <jasnell@gmail.com>
Reviewed-By: Chris Dickinson <chris@neversaw.us>

jasnell added a commit that referenced this pull request Dec 23, 2015

doc: Updated streams simplified constructor API
The examples for implementing the simplified constructor API
was missing some details on its correct usages.

PR-URL: #3602
Reviewed-By: James M Snell <jasnell@gmail.com>
Reviewed-By: Chris Dickinson <chris@neversaw.us>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
You can’t perform that action at this time.