doc: add docu for server.address() for pipe case #12907
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
Add documentation for net.server.address() for the case it is listening on a pipe or unix domain socket instead an IP socket. Fixes: #12895
nodejs-github-bot
added
doc
refack
approved these changes
May 8, 2017
Trott
reviewed
May 8, 2017
doc/api/net.md
Outdated
| `{ port: 12346, family: 'IPv4', address: '127.0.0.1' }` | ||
| `{ port: 12346, family: 'IPv4', address: '127.0.0.1' }`. | ||
|
|
||
| For servers listening on a pipe or unix domain sockets the name is returned |
There was a problem hiding this comment.
Nit: Decide whether you want singular or plural and use it for both. pipe + socket or else pipes + sockets
Nit: unix -> UNIX
Nit: comma between socket (or sockets) and the.
Trott
reviewed
May 8, 2017
doc/api/net.md
Outdated
| `{ port: 12346, family: 'IPv4', address: '127.0.0.1' }`. | ||
|
|
||
| For servers listening on a pipe or unix domain sockets the name is returned | ||
| as string. |
Trott
reviewed
May 8, 2017
doc/api/net.md
Outdated
| Useful to find which port was assigned when getting an OS-assigned address. | ||
| Returns an object with `port`, `family`, and `address` properties: | ||
| `{ port: 12346, family: 'IPv4', address: '127.0.0.1' }` | ||
| `{ port: 12346, family: 'IPv4', address: '127.0.0.1' }`. |
There was a problem hiding this comment.
Nit: Not sure why the period was added but I don't think it should be there. /cc @nodejs/documentation
|
Thanks for the improvement! I left a bunch of nits--hope that isn't discouraging. Happens a lot with documentation. They can be ignored if you want and/or they can be applied by whoever chooses to land this. |
|
Thanks for the review! Added changes. |
lpinca
approved these changes
May 9, 2017
BridgeAR
approved these changes
May 9, 2017
thefourtheye
approved these changes
May 9, 2017
There was a problem hiding this comment.
Nit: You may want to change the subsystem for this change as doc:, instead of net:. Thanks for the patch @Flarna 🙂
cjihrig
approved these changes
May 9, 2017
Flarna
changed the title
jasnell
approved these changes
May 9, 2017
|
Looks like @Trott's comments are addressed CI run: https://ci.nodejs.org/job/node-test-pull-request/7990/ |
|
CI failures on windows are machine issue, not related to change, so CI looks good. |
jasnell
pushed a commit
that referenced
this pull request
May 10, 2017
Add documentation for net.server.address() for the case it is listening on a pipe or unix domain socket instead an IP socket. PR-URL: #12907 Fixes: #12895 Reviewed-By: Refael Ackermann <[email protected]> Reviewed-By: Anna Henningsen <[email protected]> Reviewed-By: Luigi Pinca <[email protected]> Reviewed-By: Sakthipriyan Vairamani <[email protected]> Reviewed-By: Colin Ihrig <[email protected]> Reviewed-By: James M Snell <[email protected]> Reviewed-By: Michael Dawson <[email protected]>
|
Landed in 13487c4 |
anchnk
pushed a commit
to anchnk/node
that referenced
this pull request
May 19, 2017
Add documentation for net.server.address() for the case it is listening on a pipe or unix domain socket instead an IP socket. PR-URL: nodejs#12907 Fixes: nodejs#12895 Reviewed-By: Refael Ackermann <[email protected]> Reviewed-By: Anna Henningsen <[email protected]> Reviewed-By: Luigi Pinca <[email protected]> Reviewed-By: Sakthipriyan Vairamani <[email protected]> Reviewed-By: Colin Ihrig <[email protected]> Reviewed-By: James M Snell <[email protected]> Reviewed-By: Michael Dawson <[email protected]>
3 tasks
gibfahn
pushed a commit
that referenced
this pull request
Jun 20, 2017
Add documentation for net.server.address() for the case it is listening on a pipe or unix domain socket instead an IP socket. PR-URL: #12907 Fixes: #12895 Reviewed-By: Refael Ackermann <[email protected]> Reviewed-By: Anna Henningsen <[email protected]> Reviewed-By: Luigi Pinca <[email protected]> Reviewed-By: Sakthipriyan Vairamani <[email protected]> Reviewed-By: Colin Ihrig <[email protected]> Reviewed-By: James M Snell <[email protected]> Reviewed-By: Michael Dawson <[email protected]>
|
Issue was raised on v6.x, so backporting to there. |
MylesBorins
pushed a commit
that referenced
this pull request
Jul 11, 2017
Add documentation for net.server.address() for the case it is listening on a pipe or unix domain socket instead an IP socket. PR-URL: #12907 Fixes: #12895 Reviewed-By: Refael Ackermann <[email protected]> Reviewed-By: Anna Henningsen <[email protected]> Reviewed-By: Luigi Pinca <[email protected]> Reviewed-By: Sakthipriyan Vairamani <[email protected]> Reviewed-By: Colin Ihrig <[email protected]> Reviewed-By: James M Snell <[email protected]> Reviewed-By: Michael Dawson <[email protected]>
Merged
9 tasks
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.
Add documentation for net.server.address() for the case it is listening
on a pipe or unix domain socket instead an IP socket.
Fixes: #12895
Checklist
Affected core subsystem(s)
doc