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

[WIP] doc: better stream docs #19143

Closed
wants to merge 1 commit into from
+8 −1
Closed

[WIP] doc: better stream docs #19143

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
9 changes: 8 additions & 1 deletion doc/api/stream.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -28,10 +28,13 @@ objects will rarely (if ever) have need to use the `stream` module directly.

## Organization of this Document

This document is divided into two primary sections with a third section for
This document is divided into four primary sections with a fifth section for
additional notes. The first section explains the elements of the stream API that
are required to *use* streams within an application. The second section explains
the elements of the API that are required to *implement* new types of streams.
The third section is geared towards explanations and *code examples*. The fourth
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Nit: "geared towards explanations" is less informative than this should be IMO. Maybe this?

The third section explains <whatever it is supposed to explain> including code samples.

Or perhaps even better, this?

The third section contains code samples.

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Sounds good! Will update

section showcases important *npm modules* that make working with streams
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I'm not sure we really want to implement a section like that to be honest. In the past, we've avoided the appearance of promoting certain modules over their competitors. We'd want to be very careful about that.

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Sounds good! I can get rid of the specific section and maybe instead have examples that use those modules?

easier.

## Types of Streams

Expand Down Expand Up @@ -2202,6 +2205,10 @@ stream that simply passes the input bytes across to the output. Its purpose is
primarily for examples and testing, but there are some use cases where
`stream.PassThrough` is useful as a building block for novel sorts of streams.

## Explanations and Code Examples

## Important NPM Modules

## Additional Notes

<!--type=misc-->
Expand Down