Merge branch 'lukeshu/quality'

This branch works to improve code quality, without making any
substantive changes.

1 files changed, 4 insertions, 1 deletions

diff --git a/encode.go b/encode.go
index d31f36e..41032e5 100644
--- a/encode.go
+++ b/encode.go
@@ -61,11 +61,14 @@ type Encoder struct {
 	closeAfterEncode bool
 }
 
-// NewEncoder returns a new encoder.
+// NewEncoder returns a new Encoder that writes to w.
 //
 // If w is an *ReEncoder, then the inner backslash-escaping of
 // double-encoded ",string" tagged string values obeys the
 // *ReEncoder's BackslashEscape policy.
+//
+// An Encoder tends to make many small writes; if w.Write calls are
+// syscalls, then you may want to wrap w in a bufio.Writer.
 func NewEncoder(w io.Writer) *Encoder {
 	re, ok := w.(*ReEncoder)
 	if !ok {