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

Confusing and outdated tidbit in streams documentation #55987

Closed
mscdex opened this issue Nov 24, 2024 · 0 comments · Fixed by #55988
Closed

Confusing and outdated tidbit in streams documentation #55987

mscdex opened this issue Nov 24, 2024 · 0 comments · Fixed by #55988
Labels
doc Issues and PRs related to the documentations.

Comments

@mscdex
Copy link
Contributor

mscdex commented Nov 24, 2024

Affected URL(s)

https://nodejs.org/docs/latest/api/stream.html

Description of the problem

Specifically this bit:

node/doc/api/stream.md

Lines 3849 to 3850 in b6fe731

Furthermore, the `callback` should not be mixed with async/await
once it is executed when a promise is resolved.

Since the undocumented support for "thenables" was removed starting with v18.0.0, this bit in the streams documentation is outdated and should be removed.
@mscdex mscdex added the doc Issues and PRs related to the documentations. label Nov 24, 2024
@lpinca lpinca mentioned this issue Nov 25, 2024
Merged
lpinca added a commit to lpinca/node that referenced this issue Nov 25, 2024
@lpinca
doc: remove confusing and outdated sentence
982270b 
Remove confusing and outdated sentence in `doc/api/stream.md`.

Fixes: nodejs#55987
targos pushed a commit that referenced this issue Dec 2, 2024
@lpinca @targos
doc: remove confusing and outdated sentence
fa2b35d 
Remove confusing and outdated sentence in `doc/api/stream.md`.

Fixes: #55987
PR-URL: #55988
Reviewed-By: Yagiz Nizipli <yagiz@nizipli.com>
Reviewed-By: Antoine du Hamel <duhamelantoine1995@gmail.com>
Reviewed-By: Jason Zhang <xzha4350@gmail.com>
Reviewed-By: LiviaMedeiros <livia@cirno.name>
Reviewed-By: Jake Yuesong Li <jake.yuesong@gmail.com>
github-actions bot pushed a commit to aduh95/node that referenced this issue Dec 4, 2024
@lpinca @nodejs-github-bot
doc: remove confusing and outdated sentence
b62e643 
Remove confusing and outdated sentence in `doc/api/stream.md`.

Fixes: nodejs#55987
PR-URL: nodejs#55988
Reviewed-By: Yagiz Nizipli <yagiz@nizipli.com>
Reviewed-By: Antoine du Hamel <duhamelantoine1995@gmail.com>
Reviewed-By: Jason Zhang <xzha4350@gmail.com>
Reviewed-By: LiviaMedeiros <livia@cirno.name>
Reviewed-By: Jake Yuesong Li <jake.yuesong@gmail.com>
aduh95 pushed a commit to aduh95/node that referenced this issue Dec 4, 2024
@lpinca @nodejs-github-bot
doc: remove confusing and outdated sentence
2323e09 
Remove confusing and outdated sentence in `doc/api/stream.md`.

Fixes: nodejs#55987
PR-URL: nodejs#55988
Reviewed-By: Yagiz Nizipli <yagiz@nizipli.com>
Reviewed-By: Antoine du Hamel <duhamelantoine1995@gmail.com>
Reviewed-By: Jason Zhang <xzha4350@gmail.com>
Reviewed-By: LiviaMedeiros <livia@cirno.name>
Reviewed-By: Jake Yuesong Li <jake.yuesong@gmail.com>
aduh95 pushed a commit to aduh95/node that referenced this issue Dec 4, 2024
@lpinca @nodejs-github-bot
doc: remove confusing and outdated sentence
7d2436e 
Remove confusing and outdated sentence in `doc/api/stream.md`.

Fixes: nodejs#55987
PR-URL: nodejs#55988
Reviewed-By: Yagiz Nizipli <yagiz@nizipli.com>
Reviewed-By: Antoine du Hamel <duhamelantoine1995@gmail.com>
Reviewed-By: Jason Zhang <xzha4350@gmail.com>
Reviewed-By: LiviaMedeiros <livia@cirno.name>
Reviewed-By: Jake Yuesong Li <jake.yuesong@gmail.com>
aduh95 pushed a commit to aduh95/node that referenced this issue Dec 4, 2024
@lpinca @nodejs-github-bot
doc: remove confusing and outdated sentence
443a33f 
Remove confusing and outdated sentence in `doc/api/stream.md`.

Fixes: nodejs#55987
PR-URL: nodejs#55988
Reviewed-By: Yagiz Nizipli <yagiz@nizipli.com>
Reviewed-By: Antoine du Hamel <duhamelantoine1995@gmail.com>
Reviewed-By: Jason Zhang <xzha4350@gmail.com>
Reviewed-By: LiviaMedeiros <livia@cirno.name>
Reviewed-By: Jake Yuesong Li <jake.yuesong@gmail.com>
aduh95 pushed a commit to aduh95/node that referenced this issue Dec 4, 2024
@lpinca @nodejs-github-bot
doc: remove confusing and outdated sentence
5972486 
Remove confusing and outdated sentence in `doc/api/stream.md`.

Fixes: nodejs#55987
PR-URL: nodejs#55988
Reviewed-By: Yagiz Nizipli <yagiz@nizipli.com>
Reviewed-By: Antoine du Hamel <duhamelantoine1995@gmail.com>
Reviewed-By: Jason Zhang <xzha4350@gmail.com>
Reviewed-By: LiviaMedeiros <livia@cirno.name>
Reviewed-By: Jake Yuesong Li <jake.yuesong@gmail.com>
aduh95 pushed a commit to aduh95/node that referenced this issue Dec 4, 2024
@lpinca @nodejs-github-bot
doc: remove confusing and outdated sentence
82b244c 
Remove confusing and outdated sentence in `doc/api/stream.md`.

Fixes: nodejs#55987
PR-URL: nodejs#55988
Reviewed-By: Yagiz Nizipli <yagiz@nizipli.com>
Reviewed-By: Antoine du Hamel <duhamelantoine1995@gmail.com>
Reviewed-By: Jason Zhang <xzha4350@gmail.com>
Reviewed-By: LiviaMedeiros <livia@cirno.name>
Reviewed-By: Jake Yuesong Li <jake.yuesong@gmail.com>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees
No one assigned
Labels
doc Issues and PRs related to the documentations.
Projects
None yet
Milestone
No milestone
Development

Successfully merging a pull request may close this issue.

doc: remove confusing and outdated sentence lpinca/node
1 participant
@mscdex