Skip to content
New issue

Have a question about this project? # for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “#”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? # to your account

The documentation on streams is not very good. #506

Closed
gdennie opened this issue Feb 7, 2016 · 3 comments
Closed

The documentation on streams is not very good. #506

gdennie opened this issue Feb 7, 2016 · 3 comments

Comments

@gdennie
Copy link

gdennie commented Feb 7, 2016

For example, the following:

Class: stream.Transform#

Transform streams are Duplex streams where the output is in some way computed from the input. They implement both the Readable and Writable interfaces.

Examples of Transform streams include:

zlib streams
crypto streams

To state that the output is in some way computed from the input as a distinguishing characteristics of Transform streams necessitating Duplex functionality is not helpful since all streams would necessarily seem to calculate their outputs from their inputs.

@stevemao
Copy link
Contributor

stevemao commented Feb 7, 2016

The stream documentation in general has a lot of problems. see nodejs/readable-stream#181

@Knighton910
Copy link
Contributor

Like @stevemao has referenced, we're having issues with streams documentation right now. But we are working on that. This Docs Issue is a priority for us, so we'll have it fixed soon. 💯

@stevemao
Copy link
Contributor

Closing as the issue is already posted in relevant repos. This one doesn't belong here.

# for free to join this conversation on GitHub. Already have an account? # to comment
Labels
None yet
Projects
None yet
Development

No branches or pull requests

3 participants