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

@jasnell jasnell 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-bot nodejs-github-bot added doc Issues and PRs related to the documentations. stream Issues and PRs related to the stream subsystem. labels Dec 31, 2020
@jasnell jasnell requested a review from mcollina December 31, 2020 23:04

@mcollina mcollina 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

Comment thread doc/api/stream.md Outdated
Comment thread doc/api/stream.md Outdated
Comment thread doc/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"?)

Comment thread doc/api/stream.md Outdated
Comment thread doc/api/stream.md Outdated
Comment thread doc/api/stream.md Outdated
Fixes: nodejs#28592
Signed-off-by: James M Snell <jasnell@gmail.com>
@jasnell jasnell force-pushed the clarify-undocumented-stream-properties branch from 28402fe to dc2e838 Compare January 2, 2021 21:36
@jasnell

jasnell commented Jan 3, 2021

Copy link
Copy Markdown
Member Author

Landed in 7cfa1be

@jasnell jasnell closed this Jan 3, 2021
jasnell added a commit that referenced this pull request Jan 3, 2021
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
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 danielleadams mentioned this pull request Jan 12, 2021
targos pushed a commit that referenced this pull request May 1, 2021
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 danielleadams mentioned this pull request May 3, 2021
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 the documentations. stream Issues and PRs related to the stream subsystem.

Projects

None yet

Development

Successfully merging this pull request may close these issues.

doc: undocumented properties are mentioned in the stream doc

6 participants