aboutsummaryrefslogtreecommitdiff
path: root/src/encoding/binary
diff options
context:
space:
mode:
authorRobert Griesemer <gri@golang.org>2014-10-01 16:09:55 -0700
committerRobert Griesemer <gri@golang.org>2014-10-01 16:09:55 -0700
commit94f3d8cfed14e4bcb99a0389ea083cfc2ae3ab1d (patch)
treea675e05f653f664b75d5df3ce9e65d7421d3e96f /src/encoding/binary
parentdba2faf2c60bd3bf249641c7f09af2cbc984f645 (diff)
downloadgo-94f3d8cfed14e4bcb99a0389ea083cfc2ae3ab1d.tar.xz
encoding/binary: slightly better documentation
Fixes #7306. LGTM=r R=r CC=golang-codereviews https://golang.org/cl/153820044
Diffstat (limited to 'src/encoding/binary')
-rw-r--r--src/encoding/binary/binary.go7
1 files changed, 4 insertions, 3 deletions
diff --git a/src/encoding/binary/binary.go b/src/encoding/binary/binary.go
index a5694876ac..b5a377430f 100644
--- a/src/encoding/binary/binary.go
+++ b/src/encoding/binary/binary.go
@@ -10,9 +10,10 @@
// type (int8, uint8, int16, float32, complex64, ...)
// or an array or struct containing only fixed-size values.
//
-// Varints are a method of encoding integers using one or more bytes;
-// numbers with smaller absolute value take a smaller number of bytes.
-// For a specification, see http://code.google.com/apis/protocolbuffers/docs/encoding.html.
+// The varint functions encode and decode single integer values using
+// a variable-length encoding; smaller values require fewer bytes.
+// For a specification, see
+// http://code.google.com/apis/protocolbuffers/docs/encoding.html.
//
// This package favors simplicity over efficiency. Clients that require
// high-performance serialization, especially for large data structures,