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: clarify undocumented stream properties #36715

Closed
wants to merge 1 commit into from
Closed

doc: clarify undocumented stream properties #36715

wants to merge 1 commit into from

Conversation

jasnell
Copy link
Member

@jasnell jasnell commented Dec 31, 2020

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
mcollina
mcollina approved these changes Jan 1, 2021
View reviewed changes
Copy link
Member

@mcollina mcollina left a comment

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
doc/api/stream.md Outdated Show resolved Hide resolved
Trott
Trott reviewed Jan 2, 2021
View reviewed changes
doc/api/stream.md Outdated Show resolved Hide resolved
Trott
Trott reviewed Jan 2, 2021
View reviewed changes
doc/api/stream.md Outdated Show resolved Hide resolved
@Trott
Copy link
Member

Trott commented Jan 2, 2021

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
doc/api/stream.md Outdated Show resolved Hide resolved
jasnell
jasnell commented Jan 2, 2021
View reviewed changes
doc/api/stream.md Outdated Show resolved Hide resolved
jasnell
jasnell commented Jan 2, 2021
View reviewed changes
doc/api/stream.md Outdated Show resolved Hide resolved
@jasnell
doc: clarify undocumented stream properties
dc2e838 
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
Copy link
Member Author

jasnell commented Jan 3, 2021

Landed in 7cfa1be

@jasnell jasnell 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>
@danielleadams danielleadams 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>
@danielleadams danielleadams mentioned this pull request May 3, 2021
Merged
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@ronag ronag ronag approved these changes

@targos targos targos approved these changes

@Trott Trott Trott approved these changes

@mcollina mcollina mcollina approved these changes

Assignees
No one assigned
Labels
doc Issues and PRs related to the documentations. 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.

doc: undocumented properties are mentioned in the stream doc
6 participants
@jasnell @Trott @mcollina @targos @ronag @nodejs-github-bot