Improve ReadOptions docs

emersion · May 26, 2022 · 32e51cb · 32e51cb
1 parent 0de63e4
commit 32e51cb
Showing 1 changed file with 3 additions and 1 deletion.
diff --git a/entity.go b/entity.go
@@ -101,10 +101,12 @@ func (lr *limitedReader) Read(p []byte) (int, error) {
 	return n, err
 }
 
+// ReadOptions are options for ReadWithOptions.
 type ReadOptions struct {
 	// MaxHeaderBytes limits the maximum permissible size of a message header
 	// block. If exceeded, an error will be returned.
-	// -1 == no limit, 0 == default value (1MB)
+	//
+	// Set to -1 for no limit, set to 0 for the default value (1MB).
 	MaxHeaderBytes int64
 }