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: fix net.Socket link inconsistencies #20271

Closed
wants to merge 2 commits into from
Closed

doc: fix net.Socket link inconsistencies #20271

wants to merge 2 commits into from

Conversation

Hackzzila
Copy link
Contributor

Adds a link to net.Socket in the docs for tty.WriteStream to be consistent with tty.ReadStream

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 doc Issues and PRs related to the documentations. tty Issues and PRs related to the tty subsystem. labels Apr 25, 2018
vsemozhetbyt
vsemozhetbyt reviewed Apr 25, 2018
View reviewed changes
doc/api/tty.md Outdated
@@ -77,7 +77,7 @@ Note that `CTRL`+`C` will no longer cause a `SIGINT` when in this mode.
added: v0.5.8
-->

The `tty.WriteStream` class is a subclass of `net.Socket` that represents the
The `tty.WriteStream` class is a subclass of [`net.Socket`][] that represents the
Copy link
Contributor

@vsemozhetbyt vsemozhetbyt Apr 25, 2018 •
edited
Loading

Choose a reason for hiding this comment

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

This line has 81 characters now which violates 80 characters limit and will cause doc linting issue. Can you rewrap?

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

Please, add 👍 here to approve fast-tracking.

@vsemozhetbyt
Copy link
Contributor

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

@vsemozhetbyt vsemozhetbyt added the author ready PRs that have at least one approval, no pending requests for changes, and a CI started. label Apr 25, 2018
@vsemozhetbyt
Copy link
Contributor

Landed in 214fd40

vsemozhetbyt pushed a commit that referenced this pull request Apr 25, 2018
@Hackzzila @vsemozhetbyt
doc: fix net.Socket link inconsistencies
214fd40 
PR-URL: #20271
Reviewed-By: Vse Mozhet Byt <vsemozhetbyt@gmail.com>
Reviewed-By: Rich Trott <rtrott@gmail.com>
Reviewed-By: Trivikram Kamat <trivikr.dev@gmail.com>
Reviewed-By: Luigi Pinca <luigipinca@gmail.com>
@Hackzzila Hackzzila deleted the patch-2 branch April 25, 2018 14:53
MylesBorins pushed a commit that referenced this pull request May 4, 2018
@Hackzzila @MylesBorins
doc: fix net.Socket link inconsistencies
171cbb1 
PR-URL: #20271
Reviewed-By: Vse Mozhet Byt <vsemozhetbyt@gmail.com>
Reviewed-By: Rich Trott <rtrott@gmail.com>
Reviewed-By: Trivikram Kamat <trivikr.dev@gmail.com>
Reviewed-By: Luigi Pinca <luigipinca@gmail.com>
@MylesBorins MylesBorins mentioned this pull request May 8, 2018
Merged
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@trivikr trivikr trivikr approved these changes

@vsemozhetbyt vsemozhetbyt vsemozhetbyt approved these changes

@lpinca lpinca lpinca approved these changes

@Trott Trott Trott approved these changes

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. tty Issues and PRs related to the tty subsystem.
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.
6 participants
@Hackzzila @vsemozhetbyt @Trott @lpinca @trivikr @nodejs-github-bot