Skip to content

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

Closed
prog1dev wants to merge 3 commits into
nodejs:masterfrom
prog1dev:doc/improve_stream_readable_docs
Closed

prog1dev wants to merge 3 commits into
nodejs:masterfrom
prog1dev:doc/improve_stream_readable_docs

Conversation

@prog1dev

Copy link
Copy Markdown
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 Node.js documentation. stream Issues and PRs related to Node.js streams. labels Mar 15, 2018
Comment thread doc/api/stream.md Outdated
* `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
Copy Markdown
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
Copy Markdown
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 proposed for a shorter-than-standard waiting period before landing. label Mar 15, 2018
@vsemozhetbyt

Copy link
Copy Markdown
Contributor

Comment thread doc/api/stream.md Outdated
* `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
Copy Markdown
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
Copy Markdown
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
Copy Markdown
Contributor

vsemozhetbyt pushed a commit that referenced this pull request Mar 15, 2018
PR-URL: #19361
Refs: #11135
Reviewed-By: Vse Mozhet Byt <[email protected]>
Reviewed-By: Weijia Wang <[email protected]>
Reviewed-By: Yuta Hiroto <[email protected]>
@vsemozhetbyt

Copy link
Copy Markdown
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

Labels

doc Issues and PRs related to Node.js documentation. fast-track PRs proposed for a shorter-than-standard waiting period before landing. stream Issues and PRs related to Node.js streams.

Projects

None yet

Development

Successfully merging this pull request may close these issues.

7 participants