Skip to content

doc: add streams to the pipeline function signature - #34153

Closed
rickyes wants to merge 1 commit into
nodejs:masterfrom
rickyes:add-pipeline-streams-signature
Closed

doc: add streams to the pipeline function signature#34153
rickyes wants to merge 1 commit into
nodejs:masterfrom
rickyes:add-pipeline-streams-signature

Conversation

@rickyes

@rickyesrickyes commented Jul 1, 2020

Copy link
Copy Markdown
Contributor

Adding missing different function signatures

/cc @ronag@Trott

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

@nodejs-github-botnodejs-github-bot added doc Issues and PRs related to the documentations. stream Issues and PRs related to the stream subsystem. labels Jul 1, 2020
@TrottTrott added the author ready PRs that have at least one approval, no pending requests for changes, and a CI started. label Jul 1, 2020
Comment threaddoc/api/stream.md
Comment on lines 1598 to +1599
### `stream.pipeline(source[, ...transforms], destination, callback)`
### `stream.pipeline(streams, callback)`

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

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

This way of referencing multiple signatures is just awful, fwiw. Eventually, we really do need to go back and completely rearchitect our doc structure.

jasnell pushed a commit that referenced this pull request Jul 3, 2020
PR-URL: #34153
Reviewed-By: Robert Nagy <ronagy@icloud.com>
Reviewed-By: James M Snell <jasnell@gmail.com>
@jasnell

Copy link
Copy Markdown
Member

Landed in 7f2cf0f

@jasnelljasnell closed this Jul 3, 2020
@rickyes
rickyes deleted the add-pipeline-streams-signature branch July 5, 2020 03:41
MylesBorins pushed a commit that referenced this pull request Jul 14, 2020
PR-URL: #34153
Reviewed-By: Robert Nagy <ronagy@icloud.com>
Reviewed-By: James M Snell <jasnell@gmail.com>
@MylesBorinsMylesBorins mentioned this pull request Jul 14, 2020
MylesBorins pushed a commit that referenced this pull request Jul 16, 2020
PR-URL: #34153
Reviewed-By: Robert Nagy <ronagy@icloud.com>
Reviewed-By: James M Snell <jasnell@gmail.com>
@codebytere

Copy link
Copy Markdown
Member

@rickyes does this apply to v12.x?

@rickyes

Copy link
Copy Markdown
ContributorAuthor

@codebytere I don't think it applies to v12.x.

Sign up for freeto join this conversation on GitHub. Already have an account? Sign in to comment

Labels

author readyPRs that have at least one approval, no pending requests for changes, and a CI started.docIssues and PRs related to the documentations.streamIssues and PRs related to the stream subsystem.

Projects

None yet

Development

Successfully merging this pull request may close these issues.

6 participants

@rickyes@jasnell@codebytere@ronag@Trott@nodejs-github-bot