Skip to content

Commit 483fb8d

Browse files
kanozecgaryburd
authored andcommitted
Add "in bytes" to sizes in documentation
1 parent 76e4896 commit 483fb8d

File tree

3 files changed

+3
-3
lines changed

3 files changed

+3
-3
lines changed

client.go

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -70,7 +70,7 @@ type Dialer struct {
7070
// HandshakeTimeout specifies the duration for the handshake to complete.
7171
HandshakeTimeout time.Duration
7272

73-
// ReadBufferSize and WriteBufferSize specify I/O buffer sizes. If a buffer
73+
// ReadBufferSize and WriteBufferSize specify I/O buffer sizes in bytes. If a buffer
7474
// size is zero, then a useful default size is used. The I/O buffer sizes
7575
// do not limit the size of the messages that can be sent or received.
7676
ReadBufferSize, WriteBufferSize int

conn.go

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1042,7 +1042,7 @@ func (c *Conn) SetReadDeadline(t time.Time) error {
10421042
return c.conn.SetReadDeadline(t)
10431043
}
10441044

1045-
// SetReadLimit sets the maximum size for a message read from the peer. If a
1045+
// SetReadLimit sets the maximum size in bytes for a message read from the peer. If a
10461046
// message exceeds the limit, the connection sends a close message to the peer
10471047
// and returns ErrReadLimit to the application.
10481048
func (c *Conn) SetReadLimit(limit int64) {

server.go

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -27,7 +27,7 @@ type Upgrader struct {
2727
// HandshakeTimeout specifies the duration for the handshake to complete.
2828
HandshakeTimeout time.Duration
2929

30-
// ReadBufferSize and WriteBufferSize specify I/O buffer sizes. If a buffer
30+
// ReadBufferSize and WriteBufferSize specify I/O buffer sizes in bytes. If a buffer
3131
// size is zero, then buffers allocated by the HTTP server are used. The
3232
// I/O buffer sizes do not limit the size of the messages that can be sent
3333
// or received.

0 commit comments

Comments
 (0)