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

doc: general improvements to stream.md copy #6947

Closed
wants to merge 1 commit into from
Closed

doc: general improvements to stream.md copy #6947

wants to merge 1 commit into from

Conversation

jasnell
Copy link
Member

@jasnell jasnell commented May 24, 2016

Checklist
  • documentation is changed or added
  • the commit message follows commit guidelines
Affected core subsystem(s)

doc (stream)

Description of change

General improvements to stream.md. This one is significantly larger and will need a more detailed review.

@nodejs/documentation @nodejs/streams

@jasnell jasnell added doc Issues and PRs related to the documentations. stream Issues and PRs related to the stream subsystem. labels May 24, 2016
chrisdickinson
chrisdickinson reviewed May 24, 2016
View reviewed changes
doc/api/stream.md
2. The second section explains the parts of the API that you need to
use if you implement your own custom streams yourself. The API is designed to
make this easy for you to do.
The `stream` module provides the abstract API for working with streaming data
Copy link
Contributor

Choose a reason for hiding this comment

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

The original wording — "A stream is an abstract interface implemented by various objects in Node.js." — seems a bit more accurate here. The builtin module makes it easy to build objects that match the expected interface, and is used by Node internally to create stream objects — but it doesn't provide the abstract API (folks can bring their own streams!)

@jasnell
Copy link
Member Author

jasnell commented May 26, 2016

yeah, I'm thinking a second pass after this would be good.

This was referenced May 26, 2016
Closed
Closed
Closed
Closed
@addaleax
Copy link
Member

fyi, these internal hrefs in stream.md are currently broken in this PR:

#stream_api_for_stream_Implemeters
#stream_class_stream_readable_1
#stream_class_stream_writable_1
#stream_class_stream_duplex_1
#stream_class_stream_transform_1

(with Implemeters being a recurring typo in the text?)

@jasnell
Copy link
Member Author

jasnell commented May 31, 2016

Yeah, I need to go through and update the refs still. Was planning to do that before landing

@addaleax
Copy link
Member

@jasnell Sorry, didn’t mean to imply that you wouldn’t :)

@jasnell
Copy link
Member Author

jasnell commented May 31, 2016

:-) No worries at all! Just wanted to acknowledge the note

@jasnell
Copy link
Member Author

jasnell commented May 31, 2016

@chrisdickinson ... ping

@jasnell
Copy link
Member Author

jasnell commented Jun 2, 2016

@nodejs/streams @nodejs/documentation ... this is a massive update that's difficult to review in Github, but I'd like to get this landed and do a second round of edits. PTAL

@mcollina .. does this still LGTY?
@chrisdickinson ... ping again.

@mcollina
Copy link
Member

mcollina commented Jun 3, 2016

@jasnell sorry to be picky, there is a minor thing on isPaused(), you are referring as "flowing", and it is not clear if you mean the tristate or the "mode". The code actually tests for the the "state" https://github.com/nodejs/node/blob/master/lib/_stream_readable.js#L139-L141.

I would use a different term for the modes rather than the states, how about "running"?

@jasnell
Copy link
Member Author

jasnell commented Jun 3, 2016

@mcollina ... updated.

@mcollina
Copy link
Member

mcollina commented Jun 3, 2016

LGTM

@jasnell
Copy link
Member Author

jasnell commented Jun 3, 2016

If there are no further objections or comments I will land this on Monday

@jasnell
doc: general improvements to stream.md copy
866c647 
Majoring restructuring and update for streams doc.
This is the first step of multiple to updating and
correcting the streams documentation.
jasnell added a commit that referenced this pull request Jun 6, 2016
@jasnell
doc: general improvements to stream.md copy
80ea0c5 
Majoring restructuring and update for streams doc.
This is the first step of multiple to updating and
correcting the streams documentation.

PR-URL: #6947
Reviewed-By: Matteo Collina <matteo.collina@gmail.com>
@jasnell
Copy link
Member Author

jasnell commented Jun 6, 2016

Landed in 80ea0c5

@jasnell jasnell closed this Jun 6, 2016
evanlucas pushed a commit that referenced this pull request Jun 15, 2016
@jasnell @evanlucas
doc: general improvements to stream.md copy
5086e5f 
Majoring restructuring and update for streams doc.
This is the first step of multiple to updating and
correcting the streams documentation.

PR-URL: #6947
Reviewed-By: Matteo Collina <matteo.collina@gmail.com>
@evanlucas evanlucas mentioned this pull request Jun 16, 2016
Merged
This was referenced Jun 18, 2016
Closed
Closed
@MylesBorins MylesBorins mentioned this pull request Jul 11, 2016
Closed
@mcollina mcollina mentioned this pull request Jan 17, 2017
Closed
@mscdex mscdex mentioned this pull request Mar 5, 2018
Closed
2 tasks
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers
No reviews
Assignees
No one assigned
Labels
doc Issues and PRs related to the documentations. stream Issues and PRs related to the stream subsystem.
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.
6 participants
@jasnell @mcollina @addaleax @chrisdickinson @calvinmetcalf @MylesBorins