fix: add comment for the readBufferSize and writeBufferSize (#869)

### summary 😅 Every time I use `gorilla/websocket`, I need to look at the source code and find the default size for readBufferSize and writeBufferSize. I think the default value should be written in the comment. Signed-off-by: rfyiamcool <[email protected]> Co-authored-by: Alex Vulaj <[email protected]>
gorilla · Dec 7, 2023 · 01b0aae · 01b0aae
1 parent 286c896
commit 01b0aae
Showing 1 changed file with 1 addition and 0 deletions.
diff --git a/server.go b/server.go
@@ -34,6 +34,7 @@ type Upgrader struct {
 	// size is zero, then buffers allocated by the HTTP server are used. The
 	// I/O buffer sizes do not limit the size of the messages that can be sent
 	// or received.
+	// The default value is 4096 bytes, 4kb.
 	ReadBufferSize, WriteBufferSize int
 
 	// WriteBufferPool is a pool of buffers for write operations. If the value