Skip to content

Commit

Permalink
doc: various improvements to net.md
Browse files Browse the repository at this point in the history
* Improve general description of the module, specifically,
  explain that it provides TCP or local communications
  (domain sockets on UNIX, named pipes on Windows) functionalities.
* Improve explanation of `allowHalfOpen`
* Nest the overloaded `server.listen()` API in a list, explain
  the common arguments and notes in the same place.

Some minor improvements:

* Add description to the `net.Server` constructor
* Add type annotations to `server.listen()`
* Add contexts to method links

PR-URL: #11636
Reviewed-By: James M Snell <jasnell@gmail.com>
Reviewed-By: Sam Roberts <vieuxtech@gmail.com>
Reviewed-By: Anna Henningsen <anna@addaleax.net>
  • Loading branch information
joyeecheung committed Mar 4, 2017
1 parent 202b07f commit 3b05153
Showing 1 changed file with 163 additions and 123 deletions.
Loading

0 comments on commit 3b05153

Please sign in to comment.