Improve ReadOptions docs

emersion · emersion · commit 32e51cb3b3bb · 2022-05-26T11:18:46.000+02:00
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
 }
 

Original file line number	Diff line number	Diff line change
`@@ -101,10 +101,12 @@ func (lr *limitedReader) Read(p []byte) (int, error) {`
`101`	`101`	`return n, err`
`102`	`102`	`}`
`103`	`103`
	`104`	`+// ReadOptions are options for ReadWithOptions.`
`104`	`105`	`type ReadOptions struct {`
`105`	`106`	`// MaxHeaderBytes limits the maximum permissible size of a message header`
`106`	`107`	`// block. If exceeded, an error will be returned.`
`107`		`- // -1 == no limit, 0 == default value (1MB)`
	`108`	`+ //`
	`109`	`+ // Set to -1 for no limit, set to 0 for the default value (1MB).`
`108`	`110`	`MaxHeaderBytes int64`
`109`	`111`	`}`
`110`	`112`