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

TestStream is a Node stream but docs link to web ReadableStream #51174

Closed
dpogue opened this issue Dec 16, 2023 · 1 comment · Fixed by #51181
Closed

TestStream is a Node stream but docs link to web ReadableStream #51174

dpogue opened this issue Dec 16, 2023 · 1 comment · Fixed by #51181
Labels
doc Issues and PRs related to the documentations. good first issue Issues that are suitable for first-time contributors.

Comments

@dpogue
Copy link

dpogue commented Dec 16, 2023

Affected URL(s)

https://nodejs.org/api/test.html#class-testsstream

Description of the problem

The docs for TestsStream say <extends ReadableStream> which links to the Web Streams API ReadableStream page.

However, TestsStream is not a Web Stream ReadableStream, it is actually a Node Stream Readable.
@dpogue dpogue added the doc Issues and PRs related to the documentations. label Dec 16, 2023
@marco-ippolito
Copy link
Member

marco-ippolito commented Dec 16, 2023 •
edited
Loading

Would you like to open a PR to fix the documentation?

@marco-ippolito marco-ippolito added the good first issue Issues that are suitable for first-time contributors. label Dec 16, 2023
@pluris pluris mentioned this issue Dec 16, 2023
Merged
nodejs-github-bot pushed a commit that referenced this issue Dec 18, 2023
doc: fix TestsStream parent class
b931e61 
PR-URL: #51181
Fixes: #51174
Reviewed-By: Luigi Pinca <[email protected]>
Reviewed-By: Moshe Atlow <[email protected]>
Reviewed-By: Chemi Atlow <[email protected]>
RafaelGSS pushed a commit that referenced this issue Jan 2, 2024
@RafaelGSS
doc: fix TestsStream parent class
1c71435 
PR-URL: #51181
Fixes: #51174
Reviewed-By: Luigi Pinca <[email protected]>
Reviewed-By: Moshe Atlow <[email protected]>
Reviewed-By: Chemi Atlow <[email protected]>
richardlau pushed a commit that referenced this issue Mar 25, 2024
@richardlau
doc: fix TestsStream parent class
184b8be 
PR-URL: #51181
Fixes: #51174
Reviewed-By: Luigi Pinca <[email protected]>
Reviewed-By: Moshe Atlow <[email protected]>
Reviewed-By: Chemi Atlow <[email protected]>
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. good first issue Issues that are suitable for first-time contributors.
Projects
None yet
Milestone
No milestone
Development

Successfully merging a pull request may close this issue.

doc: fix TestsStream parent class pluris/node
2 participants
@dpogue @marco-ippolito