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

Jump to bottom

doc: add return values and missing options to stream readable docs #19361

Closed
wants to merge 3 commits into from
Closed

doc: add return values and missing options to stream readable docs #19361

wants to merge 3 commits into from

Conversation

prog1dev
Copy link
Contributor

Related to #11135

Checklist
  • make -j4 test (UNIX), or vcbuild test (Windows) passes
  • documentation is changed or added
  • commit message follows commit guidelines
Affected core subsystem(s)

doc, stream

@nodejs-github-bot nodejs-github-bot added doc Issues and PRs related to the documentations. stream Issues and PRs related to the stream subsystem. labels Mar 15, 2018
vsemozhetbyt
vsemozhetbyt reviewed Mar 15, 2018
View reviewed changes
doc/api/stream.md Outdated
@@ -860,6 +860,7 @@ added: v0.9.4
* `destination` {stream.Writable} The destination for writing data
* `options` {Object} Pipe options
* `end` {boolean} End the writer when the reader ends. Defaults to `true`.
* Returns {stream.Writable} making it possible to set up chains of piped streams
Copy link
Contributor

Choose a reason for hiding this comment

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

A nit: this is usually * Returns: (with a colon). The same for some other additions.

Copy link
Contributor Author

Choose a reason for hiding this comment

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

fixed in 51f9814

@vsemozhetbyt vsemozhetbyt added the fast-track PRs that do not need to wait for 48 hours to land. label Mar 15, 2018
@vsemozhetbyt
Copy link
Contributor

CI-lite: https://ci.nodejs.org/job/node-test-pull-request-lite/259/

vsemozhetbyt
vsemozhetbyt reviewed Mar 15, 2018
View reviewed changes
doc/api/stream.md Outdated
@@ -860,6 +860,7 @@ added: v0.9.4
* `destination` {stream.Writable} The destination for writing data
* `options` {Object} Pipe options
* `end` {boolean} End the writer when the reader ends. Defaults to `true`.
* Returns: {stream.Writable} making it possible to set up chains of piped streams
Copy link
Contributor

Choose a reason for hiding this comment

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

Sorry, linter issue:

  863:82  warning  Line must be at most 80 characters  maximum-line-length  remark-lint

Copy link
Contributor Author

Choose a reason for hiding this comment

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

my bad
fixed in 125df83

@vsemozhetbyt
Copy link
Contributor

CI-lite 2: https://ci.nodejs.org/job/node-test-pull-request-lite/260/

vsemozhetbyt pushed a commit that referenced this pull request Mar 15, 2018
@prog1dev @vsemozhetbyt
doc: add returned values and options to stream.md
a2c0fcc 
PR-URL: #19361
Refs: #11135
Reviewed-By: Vse Mozhet Byt <vsemozhetbyt@gmail.com>
Reviewed-By: Weijia Wang <starkwang@126.com>
Reviewed-By: Yuta Hiroto <hello@hiroppy.me>
@vsemozhetbyt
Copy link
Contributor

Landed in a2c0fcc
Thank you!

@prog1dev prog1dev deleted the doc/improve_stream_readable_docs branch March 15, 2018 02:37
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@vsemozhetbyt vsemozhetbyt vsemozhetbyt approved these changes

@hiroppy hiroppy hiroppy approved these changes

@starkwang starkwang starkwang approved these changes

Assignees
No one assigned
Labels
doc Issues and PRs related to the documentations. fast-track PRs that do not need to wait for 48 hours to land. stream Issues and PRs related to the stream subsystem.
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.

None yet
7 participants
@prog1dev @vsemozhetbyt @hiroppy @starkwang @MylesBorins @BethGriggs @nodejs-github-bot