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

doc: fix nits in stream.md #28591

Closed
wants to merge 3 commits into from

Conversation

@vsemozhetbyt
Copy link
Contributor

commented Jul 7, 2019

Checklist
  • make -j4 test (UNIX), or vcbuild test (Windows) passes
  • documentation is changed or added
  • commit message follows commit guidelines
doc: fix nits in stream.md
* Unify periods and upper case in comments.
* Add missing parentheses for methods.
* Add missing backticks.
* Fix sorting position of `writable.writableFinished` section.
* Replace a one-letter variable with a more readable one.
* `catch(console.log)` -> `catch(console.error)`.
* Document missing `emitClose` option in `new stream.Readable()` section
  mentioned in https://nodejs.org/api/stream.html#stream_event_close_1
  and https://nodejs.org/api/stream.html#stream_readable_destroy_error
  copying from the `new stream.Writable()` section.
  Refs: https://github.com/nodejs/node/blob/36fdf1aa6c87ccfaebabb8f9c8004baab0549b0b/lib/_stream_readable.js#L121
@lpinca
lpinca approved these changes Jul 7, 2019
doc/api/stream.md Outdated Show resolved Hide resolved
@Trott
Trott approved these changes Jul 8, 2019
@fhinkel
Copy link
Member

left a comment

Not blocking. But I'd prefer a separate PR for the changes that only touch documentation. That will make it much easier if the code changes happen to introduce a subtle bug.

@vsemozhetbyt

This comment has been minimized.

Copy link
Contributor Author

commented Jul 8, 2019

@fhinkel Sorry, I am not sure I understand. This PR only touches one doc file and no code files. How should I remake it?

@mcollina
Copy link
Member

left a comment

LGTM

@Trott
Trott approved these changes Jul 9, 2019
@trivikr
trivikr approved these changes Jul 9, 2019
@trivikr

This comment has been minimized.

@trivikr trivikr added the author ready label Jul 9, 2019

@vsemozhetbyt

This comment has been minimized.

Copy link
Contributor Author

commented Jul 11, 2019

Sorry, I've found out some more nits to fix in a separate fixup commit: a wrong link format with an empty href, missing return value and some missing parentheses for methods.

@BridgeAR
Copy link
Member

left a comment

Still LGTM

@Trott

This comment has been minimized.

@Trott

This comment has been minimized.

Copy link
Member

commented Jul 12, 2019

Landed in 1cc5c54

@Trott Trott closed this Jul 12, 2019

Trott added a commit to Trott/io.js that referenced this pull request Jul 12, 2019
doc: fix nits in stream.md
* Unify periods and upper case in comments.
* Add missing parentheses for methods.
* Add missing backticks.
* Fix sorting position of `writable.writableFinished` section.
* Replace a one-letter variable with a more readable one.
* `catch(console.log)` -> `catch(console.error)`.
* Document missing `emitClose` option in `new stream.Readable()` section
  mentioned in https://nodejs.org/api/stream.html#stream_event_close_1
  and https://nodejs.org/api/stream.html#stream_readable_destroy_error
  copying from the `new stream.Writable()` section.
  Refs: https://github.com/nodejs/node/blob/36fdf1aa6c87ccfaebabb8f9c8004baab0549b0b/lib/_stream_readable.js#L121

PR-URL: nodejs#28591
Reviewed-By: Luigi Pinca <luigipinca@gmail.com>
Reviewed-By: Ruben Bridgewater <ruben@bridgewater.de>
Reviewed-By: Rich Trott <rtrott@gmail.com>
Reviewed-By: Matteo Collina <matteo.collina@gmail.com>
Reviewed-By: Trivikram Kamat <trivikr.dev@gmail.com>

@vsemozhetbyt vsemozhetbyt deleted the vsemozhetbyt:doc-stream-nits branch Jul 12, 2019

targos added a commit that referenced this pull request Jul 20, 2019
doc: fix nits in stream.md
* Unify periods and upper case in comments.
* Add missing parentheses for methods.
* Add missing backticks.
* Fix sorting position of `writable.writableFinished` section.
* Replace a one-letter variable with a more readable one.
* `catch(console.log)` -> `catch(console.error)`.
* Document missing `emitClose` option in `new stream.Readable()` section
  mentioned in https://nodejs.org/api/stream.html#stream_event_close_1
  and https://nodejs.org/api/stream.html#stream_readable_destroy_error
  copying from the `new stream.Writable()` section.
  Refs: https://github.com/nodejs/node/blob/36fdf1aa6c87ccfaebabb8f9c8004baab0549b0b/lib/_stream_readable.js#L121

PR-URL: #28591
Reviewed-By: Luigi Pinca <luigipinca@gmail.com>
Reviewed-By: Ruben Bridgewater <ruben@bridgewater.de>
Reviewed-By: Rich Trott <rtrott@gmail.com>
Reviewed-By: Matteo Collina <matteo.collina@gmail.com>
Reviewed-By: Trivikram Kamat <trivikr.dev@gmail.com>
This was referenced Jul 23, 2019
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
9 participants
You can’t perform that action at this time.