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.

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

Update docs for network interfaces #543

Closed
wants to merge 1 commit into from
Closed

Update docs for network interfaces #543

wants to merge 1 commit into from

Conversation

toddself
Copy link
Contributor

doc: note that only active network ifaces appear

A proposal to fix #498 by clarifying the documentation.

@bnoordhuis
Copy link
Member

I'm inclined to accept this because changing os.networkInterfaces() behavior w.r.t. offline interfaces would constitute a rather large break with joyent/node. Can other contributors weigh in?

@toddself Can you update the commit log per the guidelines in CONTRIBUTING.md? Please wrap long lines at 80 columns. Thanks!

@bnoordhuis bnoordhuis added doc Issues and PRs related to the documentations. os Issues and PRs related to the os subsystem. labels Jan 21, 2015
@mscdex
Copy link
Contributor

mscdex commented Jan 21, 2015

Adding "down" interfaces might be a nice addition. It would also be nice to tell by an extra property whether it's "down" or not though, or maybe we could group them (e.g. os.networkInterfaces().online and os.networkInterfaces().offline)?

@toddself
Copy link
Contributor Author

Sorry! Updated with 80 column breaks.

@bnoordhuis
Copy link
Member

@toddself Can you update the commit log one more time, please? :-) The first line should be doc: short description <= 50 chars followed by one or two lines explaining the what and why of the change.

@toddself
Copy link
Contributor Author

@bnoordhuis is that what you meant in your last comment? or do i need to do a git commit --amend -m and a force push?

@bnoordhuis
Copy link
Member

@toddself Please --amend it, yes. git log doc/ if you want some examples of the template io.js uses for commit logs.

Update the documentation for `os.networkInterfaces` to note that any
interface that has not been assigned an address will not be displayed in
the results

Fixes: #498
PR-URL: #543
@toddself
Copy link
Contributor Author

@bnoordhuis thank you for the assistance on this! I tried to follow the format of previous commits that resolve an issue in the list.

bnoordhuis pushed a commit that referenced this pull request Jan 23, 2015
Update the documentation for `os.networkInterfaces` to note that any
interface that has not been assigned an address will not be displayed in
the results

Fixes: #498
PR-URL: #543
Reviewed-By: Ben Noordhuis <info@bnoordhuis.nl>
@bnoordhuis
Copy link
Member

@toddself Thanks, that looks great! Landed in 8b1db9c.

@bnoordhuis bnoordhuis closed this Jan 23, 2015
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
doc Issues and PRs related to the documentations. os Issues and PRs related to the os subsystem.
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

3 participants