Przeglądaj źródła

Improve documentation

Gary Burd 10 lat temu
rodzic
commit
423912737d
2 zmienionych plików z 9 dodań i 6 usunięć
  1. 7 4
      doc.go
  2. 2 2
      examples/command/README.md

+ 7 - 4
doc.go

@@ -97,10 +97,13 @@
 //
 // Concurrency
 //
-// Connections do not support concurrent calls to the write methods
-// (NextWriter, SetWriteDeadline, WriteMessage) or concurrent calls to the read
-// methods methods (NextReader, SetReadDeadline, ReadMessage).  Connections do
-// support a concurrent reader and writer.
+// Connections support one concurrent reader and one concurrent writer.
+//
+// Applications are responsible for ensuring that no more than one goroutine
+// calls the write methods (NextWriter, SetWriteDeadline, WriteMessage,
+// WriteJSON) concurrently and that no more than one goroutine calls the read
+// methods (NextReader, SetReadDeadline, ReadMessage, ReadJSON, SetPongHandler,
+// SetPingHandler) concurrently.
 //
 // The Close and WriteControl methods can be called concurrently with all other
 // methods.

+ 2 - 2
examples/command/README.md

@@ -1,7 +1,7 @@
 # Command example
 
 This example connects a websocket connection to stdin and stdout of a command.
-Received messages are written to stdin followed by a `\\n`. Each line read from
+Received messages are written to stdin followed by a `\n`. Each line read from
 from standard out is sent as a message to the client.
 
     $ go get github.com/gorilla/websocket
@@ -14,6 +14,6 @@ Try the following commands.
     # Echo sent messages to the output area.
     $ go run main.go cat
 
-    # Run a shell.Try sending `ls` and `cat main.go`.
+    # Run a shell.Try sending "ls" and "cat main.go".
     $ go run main.go sh