Skip to content

doc: added ready events in fs-stream, net-socket #19935

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
Closed
towc wants to merge 0 commits into from
Closed

doc: added ready events in fs-stream, net-socket #19935

towc wants to merge 0 commits into from

Conversation

@towc
Copy link
Contributor

@towc towc commented Apr 11, 2018

Added short description of the ready event in fs ReadStream,
WriteStream, and net Socket

Fixes: #19796

Checklist
  • make -j4 test (UNIX), or vcbuild test (Windows) passes
  • documentation is changed or added
  • commit message follows commit guidelines

@nodejs-github-bot nodejs-github-bot added the doc Issues and PRs related to the documentations. label Apr 11, 2018
@towc towc mentioned this pull request Apr 11, 2018
Closed
vsemozhetbyt
vsemozhetbyt approved these changes Apr 11, 2018
View reviewed changes
Copy link
Contributor

@vsemozhetbyt vsemozhetbyt left a comment

Choose a reason for hiding this comment

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

Thank you! I've left some notes about format nits, otherwise LGTM.

doc/api/fs.md Outdated
Copy link
Contributor

@vsemozhetbyt vsemozhetbyt Apr 11, 2018

Choose a reason for hiding this comment

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

Nit: ReadStream's -> `ReadStream`'s

Copy link
Contributor Author

@towc towc Apr 11, 2018

Choose a reason for hiding this comment

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

Hi! Does this mean the rest of the docs should comply to that? I'm seeing that the 'open' event doesn't wrap ReadStream in backticks either. Maybe a new issue should be opened to fix the various inconsistencies instead?

Copy link
Contributor

@vsemozhetbyt vsemozhetbyt Apr 11, 2018

Choose a reason for hiding this comment

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

Our docs have many format inconsistencies, it may be worth to not add more in new changes. But I may be wrong, so you can decide at your own discretion)

Copy link
Contributor

@vsemozhetbyt vsemozhetbyt Apr 11, 2018

Choose a reason for hiding this comment

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

I've searched all the docs for this pattern and found only these few fragments. Thank you for reporting, I will fix them ASAP: #19938

Copy link
Contributor

@vsemozhetbyt vsemozhetbyt Apr 11, 2018

Choose a reason for hiding this comment

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

Fixed.

doc/api/fs.md Outdated
Copy link
Contributor

@vsemozhetbyt vsemozhetbyt Apr 11, 2018

Choose a reason for hiding this comment

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

Nit: `open` -> `'open'`

doc/api/fs.md Outdated
Copy link
Contributor

@vsemozhetbyt vsemozhetbyt Apr 11, 2018

Choose a reason for hiding this comment

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

Nit: WriteStream's -> `WriteStream`'s

doc/api/fs.md Outdated
Copy link
Contributor

@vsemozhetbyt vsemozhetbyt Apr 11, 2018

Choose a reason for hiding this comment

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

Nit: `open` -> `'open'`

doc/api/net.md Outdated
Copy link
Contributor

@vsemozhetbyt vsemozhetbyt Apr 11, 2018

Choose a reason for hiding this comment

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

It seems this should go after ### Event: 'lookup', alphabetically.

doc/api/net.md Outdated
Copy link
Contributor

@vsemozhetbyt vsemozhetbyt Apr 11, 2018

Choose a reason for hiding this comment

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

Nit: `connect` -> `'connect'`

@BridgeAR
Copy link
Member

BridgeAR commented Apr 11, 2018

@nodejs/streams PTAL

@towc
Copy link
Contributor Author

towc commented Apr 11, 2018

@vsemozhetbyt thanks. Addressed in ab032d8

@vsemozhetbyt vsemozhetbyt added the fast-track PRs that do not need to wait for 48 hours to land. label Apr 11, 2018
@vsemozhetbyt
Copy link
Contributor

vsemozhetbyt commented Apr 11, 2018

CI-lite: https://ci.nodejs.org/job/node-test-pull-request-lite/484/

@vsemozhetbyt vsemozhetbyt added the author ready PRs that have at least one approval, no pending requests for changes, and a CI started. label Apr 11, 2018
mcollina
mcollina approved these changes Apr 11, 2018
View reviewed changes
Copy link
Member

@mcollina mcollina left a comment

Choose a reason for hiding this comment

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

LGTM

@trivikr
Copy link
Member

trivikr commented Apr 12, 2018

@towc Looks like your branch is 2596 commits behind nodejs:master

Can you please rebase from upstream/master as described in contributing guidelines?

@towc
Copy link
Contributor Author

towc commented Apr 12, 2018 •
edited
Loading

having some technical difficulties -_-

@towc towc closed this Apr 12, 2018
@towc towc force-pushed the doc-add-fs-net-ready-event branch from ef5c023 to 0aab8ff Compare April 12, 2018 08:01
@towc towc mentioned this pull request Apr 12, 2018
Closed
3 tasks
@towc
Copy link
Contributor Author

towc commented Apr 12, 2018

commands were ran, mistakes were made. The new PR resides at #19968. I apologize to the reviewers

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Reviewers

@mcollina mcollina mcollina approved these changes

@trivikr trivikr trivikr approved these changes

+1 more reviewer

@vsemozhetbyt vsemozhetbyt vsemozhetbyt approved these changes

Reviewers whose approvals may not affect merge requirements

Assignees

No one assigned

Labels

author ready PRs that have at least one approval, no pending requests for changes, and a CI started. doc Issues and PRs related to the documentations. fast-track PRs that do not need to wait for 48 hours to land.

Projects

None yet

Milestone

No milestone

Development

Successfully merging this pull request may close these issues.

fs,net: missing documentation for new "ready" events

6 participants

@towc @BridgeAR @vsemozhetbyt @trivikr @mcollina @nodejs-github-bot