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.

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

DecompressionStream and CompressionStream are documented as node v16.7.0 feature, but aren't available in any stable release #39895

Closed
ghost opened this issue Aug 26, 2021 · 5 comments
Labels
doc Issues and PRs related to the documentations. stream Issues and PRs related to the stream subsystem. web streams

Comments

@ghost
Copy link

ghost commented Aug 26, 2021

Version

v16.7.0

Platform

No response

Subsystem

docs

What steps will reproduce the bug?

This is incorrect, because they were added in 09ad64d which doesn't have a stable release yet (commit is only part of the master branch).
So this isn't even part of v16.8.0 yet:

$ node
Welcome to Node.js v16.8.0.
Type ".help" for more information.
> const stream_web = require('stream/web');
undefined
> stream_web.TransformStream
[class TransformStream]
> stream_web.DecompressionStream
undefined
> stream_web.CompressionStream
undefined

How often does it reproduce? Is there a required condition?

No response

What is the expected behavior?

Shouldn't appear in documentation, or at least be documented as unimplemented in stable versions.

Entries with added: REPLACEME shouldn't be shown in docs (certainly not with a made-up version number).
I assume that "v16.7.0" for "REPLACEME" is used as an outdated placeholder as "next release version" somewhere.

This might also affect other classes like TextDecoderStream and TextEncoderStream which are available in stable releases, but still use "REPLACEME".

What do you see instead?

No response

Additional information

No response

@Ayase-252 Ayase-252 added doc Issues and PRs related to the documentations. stream Issues and PRs related to the stream subsystem. web streams labels Aug 26, 2021
@Ayase-252
Copy link
Member

It seems that the document was released in f57a0e4, however, it is not in the origin PR #39594.

@lpinca
Copy link
Member

lpinca commented Aug 26, 2021

It seems to be a documentation issue. 09ad64d has not been backported to v16.x yet.

lpinca added a commit to lpinca/node that referenced this issue Aug 26, 2021
Documentation for `CompressionStream` and `DecompressionStream` was
erroneously added in nodejs@f57a0e4d8b

Fixes: nodejs#39895
lpinca added a commit to lpinca/node that referenced this issue Aug 26, 2021
Documentation for `CompressionStream` and `DecompressionStream` was
erroneously added in nodejs@f57a0e4d8b.

Fixes: nodejs#39895
lpinca added a commit to lpinca/node that referenced this issue Aug 26, 2021
Documentation for `CompressionStream` and `DecompressionStream` was
erroneously added in nodejs@f57a0e4d8b.

Fixes: nodejs#39895
@jasnell
Copy link
Member

jasnell commented Aug 26, 2021

Yeah, looks like the backport commit picked up the wrong docs. Odd. Hopefully 09ad64d will get backported soon. Not entirely sure why it hasn't yet.

@targos
Copy link
Member

targos commented Aug 26, 2021

Hopefully 09ad64d will get backported soon. Not entirely sure why it hasn't yet.

Just because nobody took the time to do it.

targos pushed a commit that referenced this issue Sep 6, 2021
Documentation for `CompressionStream` and `DecompressionStream` was
erroneously added in f57a0e4d8b.

Fixes: #39895

PR-URL: #39899
Reviewed-By: Michaël Zasso <targos@protonmail.com>
@lpinca
Copy link
Member

lpinca commented Sep 6, 2021

#39899 landed in 9e782eb. I'm closing this.

@lpinca lpinca closed this as completed Sep 6, 2021
@targos targos added the v16.x label Sep 6, 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. web streams
Projects
None yet
Development

No branches or pull requests

4 participants