doc: fix incorrect net listen signature #20209
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
apapirovski
added
the
fast-track
|
Please 👍 here to fast-track. |
trivikr
approved these changes
Apr 22, 2018
|
Thanks @apapirovski for a quick fix! |
lpinca
approved these changes
Apr 22, 2018
doc/api/net.md
Outdated
| @@ -296,7 +296,7 @@ added: v0.1.90 | |||
|
|
|||
| Start a [IPC][] server listening for connections on the given `path`. | |||
|
|
|||
| #### server.listen([port][, host][, backlog][, callback]) | |||
| #### server.listen([[[port[, host[, backlog]]][, callback]) | |||
There was a problem hiding this comment.
If I count correctly, for the port, host, backlog we have 5 [ and 3 ], is it OK?
There was a problem hiding this comment.
Definitely not correct. Thanks for spotting.
There was a problem hiding this comment.
Maybe it is just:
server.listen([port[, host[, backlog]]][, callback])
here and above?
|
@vsemozhetbyt Thanks for the catch. Fixed in d9b905e CI Lite: https://ci.nodejs.org/job/node-test-pull-request-lite/573/ |
lpinca
approved these changes
Apr 22, 2018
vsemozhetbyt
approved these changes
Apr 22, 2018
BridgeAR
approved these changes
Apr 22, 2018
BridgeAR
added
the
author ready
cjihrig
approved these changes
Apr 22, 2018
|
Landed in 647954d |
apapirovski
added a commit
that referenced
this pull request
Apr 22, 2018
PR-URL: #20209 Reviewed-By: Trivikram Kamat <trivikr.dev@gmail.com> Reviewed-By: Luigi Pinca <luigipinca@gmail.com> Reviewed-By: Vse Mozhet Byt <vsemozhetbyt@gmail.com> Reviewed-By: Ruben Bridgewater <ruben@bridgewater.de> Reviewed-By: Colin Ihrig <cjihrig@gmail.com>
jasnell
pushed a commit
that referenced
this pull request
Apr 23, 2018
PR-URL: #20209 Reviewed-By: Trivikram Kamat <trivikr.dev@gmail.com> Reviewed-By: Luigi Pinca <luigipinca@gmail.com> Reviewed-By: Vse Mozhet Byt <vsemozhetbyt@gmail.com> Reviewed-By: Ruben Bridgewater <ruben@bridgewater.de> Reviewed-By: Colin Ihrig <cjihrig@gmail.com>
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.
Corrects the param name from hostname to host to be consistent everywhere and also corrects the actual heading signature rather than just the instances linking to it.
Checklist
make -j4 test(UNIX), orvcbuild test(Windows) passes