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

Jump to bottom

doc: add net.Socket#timeout #34543

Closed
wants to merge 3 commits into from
Closed

doc: add net.Socket#timeout #34543

wants to merge 3 commits into from

Conversation

kobelb
Copy link
Contributor

@kobelb kobelb commented Jul 29, 2020 •
edited

Checklist

net.Socket#timeout was originally added in #21204, first being released in version 10.7.0. It's being defined here and then later consumed here; however, it's not currently documented.

@nodejs-github-bot nodejs-github-bot added doc Issues and PRs related to the documentations. net Issues and PRs related to the net subsystem. labels Jul 29, 2020
@kobelb kobelb changed the title doc: add net.Socket::timeout doc: add net.Socket#timeout Jul 29, 2020
@kobelb kobelb mentioned this pull request Jul 29, 2020
Closed
HarshithaKP
HarshithaKP reviewed Jul 29, 2020
View reviewed changes
doc/api/net.md Outdated Show resolved Hide resolved
@kobelb @HarshithaKP
doc: change net.Socket#timeout description
2841e70 
Co-authored-by: Harshitha K P <harshitha014@gmail.com>
@kobelb kobelb requested a review from a team as a code owner August 10, 2020 16:06
@Trott
Copy link
Member

Trott commented Aug 11, 2020

Landed in f1c12dc49b73

@Trott Trott closed this Aug 11, 2020
@Trott
Copy link
Member

Trott commented Aug 11, 2020

Reopening and unlanding with a force push. I think this is wrong.

@Trott Trott reopened this Aug 11, 2020
Trott
Trott requested changes Aug 11, 2020
View reviewed changes
Copy link
Member

@Trott Trott left a comment

Choose a reason for hiding this comment

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

This needs more information, I think. The property is undefined unless/until setTimeout() is called, it would seem.

Trott
Trott reviewed Aug 11, 2020
View reviewed changes
doc/api/net.md Outdated Show resolved Hide resolved
Trott
Trott reviewed Aug 11, 2020
View reviewed changes
doc/api/net.md Outdated Show resolved Hide resolved
@kobelb @Trott
doc: make it more obvious that net.Socket#timeout is potentially unde…
9166601 
…fined

Co-authored-by: Rich Trott <rtrott@gmail.com>
@kobelb
Copy link
Contributor Author

kobelb commented Aug 11, 2020

This needs more information, I think. The property is undefined unless/until setTimeout() is called, it would seem.

Thanks for the suggestions to make this behavior more clear, the docs have been updated with 9166601

@lundibundi
Copy link
Member

ping @Trott I think your review has been addressed and this ready to land (again =))

@aduh95 aduh95 added the author ready PRs that have at least one approval, no pending requests for changes, and a CI started. label Nov 8, 2020
@aduh95
Copy link
Contributor

aduh95 commented Nov 9, 2020

Landed in 5bbc4f4

@aduh95 aduh95 closed this Nov 9, 2020
aduh95 pushed a commit that referenced this pull request Nov 9, 2020
@kobelb @aduh95
doc,net: document socket.timeout
5bbc4f4 
PR-URL: #34543
Reviewed-By: Rich Trott <rtrott@gmail.com>
Reviewed-By: Trivikram Kamat <trivikr.dev@gmail.com>
Reviewed-By: Harshitha K P <harshitha014@gmail.com>
Reviewed-By: Pranshu Srivastava <rexagod@gmail.com>
Reviewed-By: James M Snell <jasnell@gmail.com>
Reviewed-By: Luigi Pinca <luigipinca@gmail.com>
Reviewed-By: Denys Otrishko <shishugi@gmail.com>
danielleadams pushed a commit that referenced this pull request Nov 9, 2020
@kobelb @danielleadams
doc,net: document socket.timeout
d6bd78f 
PR-URL: #34543
Reviewed-By: Rich Trott <rtrott@gmail.com>
Reviewed-By: Trivikram Kamat <trivikr.dev@gmail.com>
Reviewed-By: Harshitha K P <harshitha014@gmail.com>
Reviewed-By: Pranshu Srivastava <rexagod@gmail.com>
Reviewed-By: James M Snell <jasnell@gmail.com>
Reviewed-By: Luigi Pinca <luigipinca@gmail.com>
Reviewed-By: Denys Otrishko <shishugi@gmail.com>
@danielleadams danielleadams mentioned this pull request Nov 9, 2020
Merged
BethGriggs pushed a commit that referenced this pull request Dec 9, 2020
@kobelb @BethGriggs
doc,net: document socket.timeout
a70bddb 
PR-URL: #34543
Reviewed-By: Rich Trott <rtrott@gmail.com>
Reviewed-By: Trivikram Kamat <trivikr.dev@gmail.com>
Reviewed-By: Harshitha K P <harshitha014@gmail.com>
Reviewed-By: Pranshu Srivastava <rexagod@gmail.com>
Reviewed-By: James M Snell <jasnell@gmail.com>
Reviewed-By: Luigi Pinca <luigipinca@gmail.com>
Reviewed-By: Denys Otrishko <shishugi@gmail.com>
BethGriggs pushed a commit that referenced this pull request Dec 10, 2020
@kobelb @BethGriggs
doc,net: document socket.timeout
2f8722b 
PR-URL: #34543
Reviewed-By: Rich Trott <rtrott@gmail.com>
Reviewed-By: Trivikram Kamat <trivikr.dev@gmail.com>
Reviewed-By: Harshitha K P <harshitha014@gmail.com>
Reviewed-By: Pranshu Srivastava <rexagod@gmail.com>
Reviewed-By: James M Snell <jasnell@gmail.com>
Reviewed-By: Luigi Pinca <luigipinca@gmail.com>
Reviewed-By: Denys Otrishko <shishugi@gmail.com>
@BethGriggs BethGriggs mentioned this pull request Dec 10, 2020
Merged
BethGriggs pushed a commit that referenced this pull request Dec 15, 2020
@kobelb @BethGriggs
doc,net: document socket.timeout
fc17ead 
PR-URL: #34543
Reviewed-By: Rich Trott <rtrott@gmail.com>
Reviewed-By: Trivikram Kamat <trivikr.dev@gmail.com>
Reviewed-By: Harshitha K P <harshitha014@gmail.com>
Reviewed-By: Pranshu Srivastava <rexagod@gmail.com>
Reviewed-By: James M Snell <jasnell@gmail.com>
Reviewed-By: Luigi Pinca <luigipinca@gmail.com>
Reviewed-By: Denys Otrishko <shishugi@gmail.com>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@jasnell jasnell jasnell approved these changes

@Trott Trott Trott approved these changes

@lpinca lpinca lpinca approved these changes

@lundibundi lundibundi lundibundi approved these changes

@trivikr trivikr trivikr approved these changes

@rexagod rexagod rexagod approved these changes

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

Successfully merging this pull request may close these issues.

None yet
10 participants
@kobelb @Trott @lundibundi @aduh95 @jasnell @lpinca @trivikr @rexagod @HarshithaKP @nodejs-github-bot