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

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

Closed
wants to merge 2 commits into
base: master
from

Conversation

@Flarna
Contributor

Flarna commented May 8, 2017

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

net: add docu for server.address() for pipe case
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
@refack

refack approved these changes May 8, 2017

Show outdated Hide outdated 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

This comment has been minimized.

@Trott

Trott May 8, 2017

Member

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

Trott May 8, 2017

Member

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.

Show outdated Hide outdated 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.

This comment has been minimized.

@Trott

Trott May 8, 2017

Member

Nit: as a string.

@Trott

Trott May 8, 2017

Member

Nit: as a string.

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

This comment has been minimized.

@Trott

Trott May 8, 2017

Member

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

@Trott

Trott May 8, 2017

Member

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

@Trott

This comment has been minimized.

Show comment
Hide comment
@Trott

Trott May 8, 2017

Member

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.

Member

Trott commented May 8, 2017

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!

Gerhard Stoebich
@Flarna

This comment has been minimized.

Show comment
Hide comment
@Flarna

Flarna May 9, 2017

Contributor

Thanks for the review! Added changes.

Contributor

Flarna commented May 9, 2017

Thanks for the review! Added changes.

@lpinca

lpinca approved these changes May 9, 2017

@thefourtheye

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

@cjihrig

cjihrig approved these changes May 9, 2017

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

@jasnell

jasnell approved these changes May 9, 2017

@mhdawson

LGTM

@mhdawson

This comment has been minimized.

Show comment
Hide comment
@mhdawson

mhdawson May 10, 2017

Member

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

Member

mhdawson commented May 10, 2017

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

@mhdawson

This comment has been minimized.

Show comment
Hide comment
@mhdawson

mhdawson May 10, 2017

Member

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

Member

mhdawson commented May 10, 2017

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

jasnell added a commit that referenced this pull request May 10, 2017

doc: add docs for server.address() for pipe case
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 <refack@gmail.com>
Reviewed-By: Anna Henningsen <anna@addaleax.net>
Reviewed-By: Luigi Pinca <luigipinca@gmail.com>
Reviewed-By: Sakthipriyan Vairamani <thechargingvolcano@gmail.com>
Reviewed-By: Colin Ihrig <cjihrig@gmail.com>
Reviewed-By: James M Snell <jasnell@gmail.com>
Reviewed-By: Michael Dawson <michael_dawson@ca.ibm.com>
@jasnell

This comment has been minimized.

Show comment
Hide comment
@jasnell

jasnell May 10, 2017

Member

Landed in 13487c4

Member

jasnell commented May 10, 2017

Landed in 13487c4

@jasnell jasnell closed this May 10, 2017

@Flarna Flarna deleted the Flarna:net_server_address_doc branch May 10, 2017

anchnk added a commit to anchnk/node that referenced this pull request May 19, 2017

doc: add docs for server.address() for pipe case
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 <refack@gmail.com>
Reviewed-By: Anna Henningsen <anna@addaleax.net>
Reviewed-By: Luigi Pinca <luigipinca@gmail.com>
Reviewed-By: Sakthipriyan Vairamani <thechargingvolcano@gmail.com>
Reviewed-By: Colin Ihrig <cjihrig@gmail.com>
Reviewed-By: James M Snell <jasnell@gmail.com>
Reviewed-By: Michael Dawson <michael_dawson@ca.ibm.com>

@jasnell jasnell referenced this pull request May 28, 2017

Closed

8.0.0 Release Proposal #12220

@gibfahn gibfahn referenced this pull request Jun 15, 2017

Closed

Auditing for 6.11.1 #230

2 of 3 tasks complete

gibfahn added a commit that referenced this pull request Jun 20, 2017

doc: add docs for server.address() for pipe case
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 <refack@gmail.com>
Reviewed-By: Anna Henningsen <anna@addaleax.net>
Reviewed-By: Luigi Pinca <luigipinca@gmail.com>
Reviewed-By: Sakthipriyan Vairamani <thechargingvolcano@gmail.com>
Reviewed-By: Colin Ihrig <cjihrig@gmail.com>
Reviewed-By: James M Snell <jasnell@gmail.com>
Reviewed-By: Michael Dawson <michael_dawson@ca.ibm.com>
@gibfahn

This comment has been minimized.

Show comment
Hide comment
@gibfahn

gibfahn Jun 20, 2017

Member

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

Member

gibfahn commented Jun 20, 2017

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

MylesBorins added a commit that referenced this pull request Jul 11, 2017

doc: add docs for server.address() for pipe case
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 <refack@gmail.com>
Reviewed-By: Anna Henningsen <anna@addaleax.net>
Reviewed-By: Luigi Pinca <luigipinca@gmail.com>
Reviewed-By: Sakthipriyan Vairamani <thechargingvolcano@gmail.com>
Reviewed-By: Colin Ihrig <cjihrig@gmail.com>
Reviewed-By: James M Snell <jasnell@gmail.com>
Reviewed-By: Michael Dawson <michael_dawson@ca.ibm.com>

@MylesBorins MylesBorins referenced this pull request Jul 18, 2017

Merged

v6.11.2 proposal #14356

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment