Final doc fixes

Author: nhooyr

README.md

@@ -16,7 +16,7 @@ go get nhooyr.io/websocket
 - First class [context.Context](https://blog.golang.org/context) support
 - Fully passes the WebSocket [autobahn-testsuite](https://github.com/crossbario/autobahn-testsuite)
 - Thorough tests with [90% coverage](https://coveralls.io/github/nhooyr/websocket)
-- [Zero dependencies](https://pkg.go.dev/nhooyr.io/websocket?tab=imports)
+- [Minimal dependencies](https://pkg.go.dev/nhooyr.io/websocket?tab=imports)
 - JSON and protobuf helpers in the [wsjson](https://pkg.go.dev/nhooyr.io/websocket/wsjson) and [wspb](https://pkg.go.dev/nhooyr.io/websocket/wspb) subpackages
 - Zero alloc reads and writes
 - Concurrent writes

accept.go

@@ -134,7 +134,7 @@ func accept(w http.ResponseWriter, r *http.Request, opts *AcceptOptions) (_ *Con
 	b, _ := brw.Reader.Peek(brw.Reader.Buffered())
 	brw.Reader.Reset(io.MultiReader(bytes.NewReader(b), netConn))
 
-	c := newConn(connConfig{
+	return newConn(connConfig{
 		subprotocol:    w.Header().Get("Sec-WebSocket-Protocol"),
 		rwc:            netConn,
 		client:         false,
@@ -143,9 +143,7 @@ func accept(w http.ResponseWriter, r *http.Request, opts *AcceptOptions) (_ *Con
 
 		br: brw.Reader,
 		bw: brw.Writer,
-	})
-
-	return c, nil
+	}), nil
 }
 
 func verifyClientRequest(w http.ResponseWriter, r *http.Request) (errCode int, _ error) {

conn_test.go

@@ -271,7 +271,6 @@ func TestWasm(t *testing.T) {
 		t.Skip("skipping on CI")
 	}
 
-	// TODO grace
 	s := httptest.NewServer(http.HandlerFunc(func(w http.ResponseWriter, r *http.Request) {
 		c, err := websocket.Accept(w, r, &websocket.AcceptOptions{
 			Subprotocols:   []string{"echo"},

examples/chat/chat_test.go

@@ -130,7 +130,6 @@ func setupTest(t *testing.T) (url string, closeFn func()) {
 	cs.subscriberMessageBuffer = 4096
 	cs.publishLimiter.SetLimit(rate.Inf)
 
-	// TODO grace
 	s := httptest.NewServer(cs)
 	return s.URL, func() {
 		s.Close()

examples/chat/main.go

@@ -34,8 +34,7 @@ func run() error {
 	log.Printf("listening on http://%v", l.Addr())
 
 	cs := newChatServer()
-	// TODO grace
-	s := http.Server{
+	s := &http.Server{
 		Handler:      cs,
 		ReadTimeout:  time.Second * 10,
 		WriteTimeout: time.Second * 10,

examples/echo/main.go

@@ -16,11 +16,6 @@ import (
 	"nhooyr.io/websocket/wsjson"
 )
 
-// TODO IMPROVE CANCELLATION AND SHUTDOWN
-// TODO on context cancel send websocket going away and fix the read timeout error to be dependant on context deadline reached.
-// TODO this way you cancel your context and the right message automatically gets sent. Furthrmore, then u can just use a simple waitgroup to wait for connections.
-// TODO grace is wrong as it doesn't wait for the individual goroutines.
-
 // This example starts a WebSocket echo server,
 // dials the server and then sends 5 different messages
 // and prints out the server's responses.
@@ -34,7 +29,6 @@ func main() {
 	}
 	defer l.Close()
 
-	// TODO grace
 	s := &http.Server{
 		Handler: http.HandlerFunc(func(w http.ResponseWriter, r *http.Request) {
 			err := echoServer(w, r)