doc: fix family default value in socket.connect #28521
Closed
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
nodejs-github-bot
added
doc
lpinca
approved these changes
Jul 3, 2019
Trott
approved these changes
Jul 3, 2019
Trott
reviewed
Jul 3, 2019
| @@ -618,8 +618,8 @@ For TCP connections, available `options` are: | |||
| * `host` {string} Host the socket should connect to. **Default:** `'localhost'`. | |||
| * `localAddress` {string} Local address the socket should connect from. | |||
| * `localPort` {number} Local port the socket should connect from. | |||
| * `family` {number}: Version of IP stack, can be either `4` or `6`. | |||
| **Default:** `4`. | |||
| * `family` {number}: Version of IP stack. Must be `4`, `6`, or `0`. | |||
There was a problem hiding this comment.
This may not be worth "fixing" as the fix may make the documentation more confusing while helping no one, but strictly speaking, if you pass a string value for family, it will work too. So both the {number} designation and the list of acceptable values are too narrow.
There was a problem hiding this comment.
(If that is worth fixing, it probably should go in a different pull request as it might result in discussion that this change as-is probably won't. Might as well get this in and then "fix" the above either later or never.)
Trott
added
the
author ready
trivikr
approved these changes
Jul 3, 2019
BridgeAR
approved these changes
Jul 4, 2019
|
Landed in fd23c12 |
Trott
pushed a commit
to Trott/io.js
that referenced
this pull request
Jul 6, 2019
PR-URL: nodejs#28521 Reviewed-By: Luigi Pinca <luigipinca@gmail.com> Reviewed-By: Rich Trott <rtrott@gmail.com> Reviewed-By: Trivikram Kamat <trivikr.dev@gmail.com> Reviewed-By: Ruben Bridgewater <ruben@bridgewater.de>
targos
pushed a commit
that referenced
this pull request
Jul 20, 2019
PR-URL: #28521 Reviewed-By: Luigi Pinca <luigipinca@gmail.com> Reviewed-By: Rich Trott <rtrott@gmail.com> Reviewed-By: Trivikram Kamat <trivikr.dev@gmail.com> Reviewed-By: Ruben Bridgewater <ruben@bridgewater.de>
This was referenced Jul 23, 2019
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Documentation says that default value is
4, but in code no any default value:node/lib/net.js
Line 942 in d3b10f6
as result
dns.lookupuses own default --0.Checklist
make -j4 test(UNIX), orvcbuild test(Windows) passes