summaryrefslogtreecommitdiff
path: root/src/encoding
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
commitcaed88cb1883491028f889e844751c4a8ebb461d (patch)
treec741fb95dfe63aa3aab2d473dd32ece81ffa89b5 /src/encoding
parent03ad4cafb641a61aac3bed5ee7aa3502e24424df (diff)
downloadgo-caed88cb1883491028f889e844751c4a8ebb461d.tar.gz
encoding/binary: slightly better documentation
Fixes issue 7306. LGTM=r R=r CC=golang-codereviews https://codereview.appspot.com/153820044
Diffstat (limited to 'src/encoding')
-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 a5694876a..b5a377430 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,