Skip to content

doc: clarify undocumented stream properties - #36715

Closed
jasnell wants to merge 1 commit into
nodejs:masterfrom
jasnell:clarify-undocumented-stream-properties
Closed

doc: clarify undocumented stream properties#36715
jasnell wants to merge 1 commit into
nodejs:masterfrom
jasnell:clarify-undocumented-stream-properties

Conversation

@jasnell

@jasnelljasnell commented Dec 31, 2020

Copy link
Copy Markdown
Member

Fixes: #28592
Signed-off-by: James M Snell jasnell@gmail.com

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 Dec 31, 2020
mcollina
mcollina approved these changes Jan 1, 2021
View reviewed changes

@mcollinamcollina left a comment

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.

lgtm

Trott
Trott reviewed Jan 2, 2021
View reviewed changes
Comment threaddoc/api/stream.md Outdated
Trott
Trott reviewed Jan 2, 2021
View reviewed changes
Comment threaddoc/api/stream.md Outdated
Trott
Trott reviewed Jan 2, 2021
View reviewed changes
Comment threaddoc/api/stream.md Outdated
@Trott

Trott commented Jan 2, 2021

Copy link
Copy Markdown
Member

I suggested removing "undocumented" in one of my comments because we're talking about them in the documentation, so they're not exactly undocumented. So I'd also suggest removing it from the commit message. (If removing it doesn't feel right, maybe change it to "unsupported"?)

jasnell
jasnell commented Jan 2, 2021
View reviewed changes
Comment threaddoc/api/stream.md Outdated
jasnell
jasnell commented Jan 2, 2021
View reviewed changes
Comment threaddoc/api/stream.md Outdated
jasnell
jasnell commented Jan 2, 2021
View reviewed changes
Comment threaddoc/api/stream.md Outdated
@jasnell
doc: clarify undocumented stream properties
dc2e838
Fixes: nodejs#28592
Signed-off-by: James M Snell <jasnell@gmail.com>
@jasnell
jasnellforce-pushed the clarify-undocumented-stream-properties branch from 28402fe to dc2e838CompareJanuary 2, 2021 21:36
@jasnell

jasnell commented Jan 3, 2021

Copy link
Copy Markdown
MemberAuthor

Landed in 7cfa1be

@jasnelljasnell closed this Jan 3, 2021
jasnell added a commit that referenced this pull request Jan 3, 2021
@jasnell
doc: clarify undocumented stream properties
7cfa1be
Fixes: #28592
Signed-off-by: James M Snell <jasnell@gmail.com>
PR-URL: #36715
Reviewed-By: Matteo Collina <matteo.collina@gmail.com>
Reviewed-By: Rich Trott <rtrott@gmail.com>
Reviewed-By: Robert Nagy <ronagy@icloud.com>
Reviewed-By: Michaël Zasso <targos@protonmail.com>
danielleadams pushed a commit that referenced this pull request Jan 12, 2021
@jasnell@danielleadams
doc: clarify undocumented stream properties
214dbac
Fixes: #28592
Signed-off-by: James M Snell <jasnell@gmail.com>
PR-URL: #36715
Reviewed-By: Matteo Collina <matteo.collina@gmail.com>
Reviewed-By: Rich Trott <rtrott@gmail.com>
Reviewed-By: Robert Nagy <ronagy@icloud.com>
Reviewed-By: Michaël Zasso <targos@protonmail.com>
@danielleadamsdanielleadams mentioned this pull request Jan 12, 2021
Merged
targos pushed a commit that referenced this pull request May 1, 2021
@jasnell@targos
doc: clarify undocumented stream properties
71b94e1
Fixes: #28592
Signed-off-by: James M Snell <jasnell@gmail.com>
PR-URL: #36715
Reviewed-By: Matteo Collina <matteo.collina@gmail.com>
Reviewed-By: Rich Trott <rtrott@gmail.com>
Reviewed-By: Robert Nagy <ronagy@icloud.com>
Reviewed-By: Michaël Zasso <targos@protonmail.com>
@danielleadamsdanielleadams mentioned this pull request May 3, 2021
Merged
Sign up for freeto join this conversation on GitHub. Already have an account? Sign in to comment

Reviewers

@mcollinamcollinamcollina approved these changes
@TrottTrottTrott approved these changes
@targostargostargos approved these changes
@ronagronagronag approved these changes

Assignees

No one assigned

Labels

docIssues and PRs related to the documentations.streamIssues and PRs related to the stream subsystem.

Projects

None yet

Milestone

No milestone

Development

Successfully merging this pull request may close these issues.

doc: undocumented properties are mentioned in the stream doc

6 participants

@jasnell@Trott@mcollina@targos@ronag@nodejs-github-bot