code review 5673076: net: package doc overview / examples

net: package doc overview / examples

Fixes issue 2774

[bradfitz, 2012-02-17 00:47:57]

Hello golang-dev@googlegroups.com,

I'd like you to review this change to
https://go.googlecode.com/hg/

[r, 2012-02-17 00:56:21]

http://codereview.appspot.com/5673076/diff/5001/src/pkg/net/net.go
File src/pkg/net/net.go (right):

http://codereview.appspot.com/5673076/diff/5001/src/pkg/net/net.go#newcode6
src/pkg/net/net.go:6: Package net provides a portable interface to Unix networks
sockets,
s/networks/network/

http://codereview.appspot.com/5673076/diff/5001/src/pkg/net/net.go#newcode7
src/pkg/net/net.go:7: including TCP/IP, UDP, domain name resolution, and Unix
domain sockets.

Although the package provides access to low-level networking primitives, most
clients will need only the portable interface provided by Dial, Listen, and
Accept functions.

(if that's right, and the right list)

[bradfitz, 2012-02-17 01:51:15]

Hello golang-dev@googlegroups.com, r@golang.org (cc:
golang-dev@googlegroups.com),

Please take another look.

[r, 2012-02-17 01:53:28]

LGTM
(but make sure the example compiles and runs, just in case)

[bradfitz, 2012-02-17 02:07:12]

*** Submitted as http://code.google.com/p/go/source/detail?r=0effb05ba6ea ***

net: package doc overview / examples

Fixes issue 2774

R=golang-dev, r
CC=golang-dev
http://codereview.appspot.com/5673076

[rsc, 2012-02-17 02:57:02]

It would be nice for this comment to mention the
generic types Conn and Listener too and say that while
specific concrete implementations exist, most code
should use the general ones.  Also it might be worth
noting that other packages and do implement
these interfaces too.  In particular crypto/tls provides
the same kind of API and the same exact interfaces
with its Dial and Listen.