Skip to content

Commit

Permalink
doc: note in docs about missing interfaces
Browse files Browse the repository at this point in the history
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>
  • Loading branch information
toddself authored and bnoordhuis committed Jan 23, 2015
1 parent 2928ac6 commit 8b1db9c
Showing 1 changed file with 3 additions and 0 deletions.
3 changes: 3 additions & 0 deletions doc/api/os.markdown
Original file line number Diff line number Diff line change
Expand Up @@ -159,6 +159,9 @@ Get a list of network interfaces:
mac: '01:02:03:0a:0b:0c',
internal: false } ] }

Note that due to the underlying implementation this will only return network
interfaces that have been assigned an address.

## os.EOL

A constant defining the appropriate End-of-line marker for the operating system.

0 comments on commit 8b1db9c

Please sign in to comment.