Commit e0405b73 authored by Rob Pike's avatar Rob Pike

encoding/binary: document its goals better

It's a modest package with modest goals and limitations.
Make that clear.

R=golang-dev, dsymonds
CC=golang-dev
https://golang.org/cl/12694043
parent 66e84713
...@@ -2,8 +2,8 @@ ...@@ -2,8 +2,8 @@
// Use of this source code is governed by a BSD-style // Use of this source code is governed by a BSD-style
// license that can be found in the LICENSE file. // license that can be found in the LICENSE file.
// Package binary implements translation between numbers and byte sequences // Package binary implements simple translation between numbers and byte
// and encoding and decoding of varints. // sequences and encoding and decoding of varints.
// //
// Numbers are translated by reading and writing fixed-size values. // Numbers are translated by reading and writing fixed-size values.
// A fixed-size value is either a fixed-size arithmetic // A fixed-size value is either a fixed-size arithmetic
...@@ -13,6 +13,11 @@ ...@@ -13,6 +13,11 @@
// Varints are a method of encoding integers using one or more bytes; // Varints are a method of encoding integers using one or more bytes;
// numbers with smaller absolute value take a smaller number of 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. // 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,
// should look at more advanced solutions such as the encoding/gob
// package or protocol buffers.
package binary package binary
import ( import (
......
Markdown is supported
0%
or
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment