rlp: document that zero value of EncoderBuffer is not valid

ethereum · Feb 7, 2022 · 72069de · 72069de
1 parent 322d291
commit 72069de
Showing 1 changed file with 3 additions and 0 deletions.
diff --git a/rlp/encbuffer.go b/rlp/encbuffer.go
@@ -249,6 +249,9 @@ func (r *encReader) next() []byte {
 }
 
 // EncoderBuffer is a buffer for incremental encoding.
+//
+// The zero value is NOT ready for use. To get a usable buffer,
+// create it using NewEncoderBuffer or call Reset.
 type EncoderBuffer struct {
 	buf *encBuffer
 	dst io.Writer