Skip to content
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.

Sign up for GitHub

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

Jump to bottom

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

Closed
wants to merge 2 commits into from
Closed

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

wants to merge 2 commits into from

Conversation

Flarna
Copy link
Member

@Flarna Flarna commented May 8, 2017 •
edited
Loading

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

@Flarna
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 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
Trott
Trott reviewed May 8, 2017
View reviewed changes
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
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

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 reviewed May 8, 2017
View reviewed changes
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.
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Nit: as a string.

Trott
Trott reviewed May 8, 2017
View reviewed changes
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' }`.
Copy link
Member

@Trott Trott May 8, 2017 •
edited
Loading

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

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

@Trott
Copy link
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
addaleax approved these changes May 9, 2017
View reviewed changes
Copy link
Member

@addaleax addaleax left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

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

@Flarna
Copy link
Member Author

Flarna commented May 9, 2017

Thanks for the review! Added changes.

thefourtheye
thefourtheye approved these changes May 9, 2017
View reviewed changes
Copy link
Contributor

@thefourtheye thefourtheye left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

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

@Flarna 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
mhdawson
mhdawson approved these changes May 9, 2017
View reviewed changes
Copy link
Member

@mhdawson mhdawson left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

LGTM

@mhdawson
Copy link
Member

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

@mhdawson
Copy link
Member

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
@Flarna @jasnell
doc: add docs for server.address() for pipe case
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: #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
Copy link
Member

jasnell commented May 10, 2017

Landed in 13487c4

@jasnell jasnell closed this May 10, 2017
@Flarna Flarna deleted the net_server_address_doc branch May 10, 2017 19:11
@bnoordhuis bnoordhuis mentioned this pull request May 11, 2017
Closed
anchnk pushed a commit to anchnk/node that referenced this pull request May 19, 2017
@Flarna
doc: add docs for server.address() for pipe case
8174197 
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 mentioned this pull request May 28, 2017
Closed
@gibfahn gibfahn mentioned this pull request Jun 15, 2017
Closed
3 tasks
gibfahn pushed a commit that referenced this pull request Jun 20, 2017
@Flarna @gibfahn
doc: add docs for server.address() for pipe case
9f83d59 
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
Copy link
Member

gibfahn commented Jun 20, 2017

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

MylesBorins pushed a commit that referenced this pull request Jul 11, 2017
@Flarna @MylesBorins
doc: add docs for server.address() for pipe case
c01a2d5 
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 mentioned this pull request Jul 18, 2017
Merged
@Flarna Flarna mentioned this pull request Jun 1, 2018
Merged
9 tasks
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@Trott Trott Trott left review comments

@mhdawson mhdawson mhdawson approved these changes

@BridgeAR BridgeAR BridgeAR approved these changes

@cjihrig cjihrig cjihrig approved these changes

@lpinca lpinca lpinca approved these changes

@addaleax addaleax addaleax approved these changes

@thefourtheye thefourtheye thefourtheye approved these changes

@jasnell jasnell jasnell approved these changes

@refack refack refack approved these changes

Assignees
No one assigned
Labels
doc Issues and PRs related to the documentations. net Issues and PRs related to the net subsystem.
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.

net.Server.address() returns a string instead of an object for Pipes