doc: add docu for server.address() for pipe case by Flarna · Pull Request #12907 · nodejs/node

Flarna · 2017-05-08T20:36:12Z

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

documentation is changed or added
commit message follows commit guidelines

Affected core subsystem(s)

doc

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

Trott · 2017-05-08T23:32:41Z

doc/api/net.md

-`{ 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


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 · 2017-05-08T23:32:52Z

doc/api/net.md

+`{ 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.


Nit: as a string.

Trott · 2017-05-08T23:33:31Z

doc/api/net.md

 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' }`.


Nit: Not sure why the period was added but I don't think it should be there. /cc @nodejs/documentation

Trott · 2017-05-08T23:34:48Z

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.

addaleax

Looks good with @Trott’s suggestions, thank you!

Flarna · 2017-05-09T06:31:53Z

Thanks for the review! Added changes.

thefourtheye

Nit: You may want to change the subsystem for this change as doc:, instead of net:. Thanks for the patch @Flarna 🙂

mhdawson

LGTM

mhdawson · 2017-05-10T13:19:15Z

Looks like @Trott's comments are addressed CI run: https://ci.nodejs.org/job/node-test-pull-request/7990/

mhdawson · 2017-05-10T16:52:22Z

CI failures on windows are machine issue, not related to change, so CI looks good.

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]>

jasnell · 2017-05-10T19:04:56Z

Landed in 13487c4

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]>

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]>

gibfahn · 2017-06-20T23:09:15Z

Issue was raised on v6.x, so backporting to there.

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]>

net: add docu for server.address() for pipe case

a9b133b

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 Issues and PRs related to the documentations. net Issues and PRs related to the net subsystem. labels May 8, 2017

refack approved these changes May 8, 2017

View reviewed changes

Trott reviewed May 8, 2017

View reviewed changes

addaleax approved these changes May 9, 2017

View reviewed changes

correct review findings

73ff8d7

lpinca approved these changes May 9, 2017

View reviewed changes

BridgeAR approved these changes May 9, 2017

View reviewed changes

thefourtheye approved these changes May 9, 2017

View reviewed changes

cjihrig approved these changes May 9, 2017

View reviewed changes

Flarna changed the title ~~net, doc: add docu for server.address() for pipe case~~ doc: add docu for server.address() for pipe case May 9, 2017

jasnell approved these changes May 9, 2017

View reviewed changes

mhdawson approved these changes May 9, 2017

View reviewed changes

jasnell closed this May 10, 2017

Flarna deleted the net_server_address_doc branch May 10, 2017 19:11

bnoordhuis mentioned this pull request May 11, 2017

socket name of unix domain sockets #954

Closed

jasnell mentioned this pull request May 28, 2017

8.0.0 Release Proposal #12220

Closed

gibfahn mentioned this pull request Jun 15, 2017

Auditing for 6.11.1 nodejs/Release#230

Closed

3 tasks

gibfahn added the land-on-v6.x label Jun 20, 2017

MylesBorins mentioned this pull request Jul 18, 2017

v6.11.2 proposal #14356

Merged

Flarna mentioned this pull request Jun 1, 2018

node, ws: address() method on Server and related classes can return a string DefinitelyTyped/DefinitelyTyped#25597

Merged

9 tasks

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Uh oh!

doc: add docu for server.address() for pipe case#12907

doc: add docu for server.address() for pipe case#12907
Flarna wants to merge 2 commits intonodejs:masterfrom
Flarna:net_server_address_doc

Flarna commented May 8, 2017 •

edited

Loading

Uh oh!

Trott May 8, 2017

Uh oh!

Trott May 8, 2017

Uh oh!

Trott May 8, 2017 •

edited

Loading

Uh oh!

Trott commented May 8, 2017

Uh oh!

addaleax left a comment

Uh oh!

Flarna commented May 9, 2017

Uh oh!

thefourtheye left a comment

Uh oh!

mhdawson left a comment

Uh oh!

mhdawson commented May 10, 2017

Uh oh!

mhdawson commented May 10, 2017

Uh oh!

jasnell commented May 10, 2017

Uh oh!

gibfahn commented Jun 20, 2017

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

12 participants

Uh oh!

Conversation

Flarna commented May 8, 2017 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Checklist

Affected core subsystem(s)

Uh oh!

Trott May 8, 2017

Choose a reason for hiding this comment

Uh oh!

Trott May 8, 2017

Choose a reason for hiding this comment

Uh oh!

Trott May 8, 2017 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Trott commented May 8, 2017

Uh oh!

addaleax left a comment

Choose a reason for hiding this comment

Uh oh!

Flarna commented May 9, 2017

Uh oh!

thefourtheye left a comment

Choose a reason for hiding this comment

Uh oh!

mhdawson left a comment

Choose a reason for hiding this comment

Uh oh!

mhdawson commented May 10, 2017

Uh oh!

mhdawson commented May 10, 2017

Uh oh!

jasnell commented May 10, 2017

Uh oh!

gibfahn commented Jun 20, 2017

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

12 participants

Flarna commented May 8, 2017 •

edited

Loading

Trott May 8, 2017 •

edited

Loading