Improve documentation

This commit is contained in:
Gary Burd 2015-10-19 15:05:01 -07:00
parent d14d8b4715
commit 423912737d
2 changed files with 9 additions and 6 deletions

11
doc.go
View File

@ -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.

View File

@ -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