code review 153820044: encoding/binary: slightly better documentation

encoding/binary: slightly better documentation

Fixes issue 7306.

[gri, 2014-10-01 21:46:08]

Hello r (cc: golang-codereviews@googlegroups.com),

I'd like you to review this change to
https://code.google.com/p/go/

[gri, 2014-10-01 21:50:35]

Hello r@golang.org (cc: golang-codereviews@googlegroups.com),

Please take another look.

[r, 2014-10-01 22:36:30]

https://codereview.appspot.com/153820044/diff/20001/src/encoding/binary/binar...
File src/encoding/binary/binary.go (right):

https://codereview.appspot.com/153820044/diff/20001/src/encoding/binary/binar...
src/encoding/binary/binary.go:13: // The Xvarint functions encode and decode
single integer values using
s/X// it adds nothing.

https://codereview.appspot.com/153820044/diff/20001/src/encoding/binary/binar...
src/encoding/binary/binary.go:14: // one or more bytes; numbers with smaller
absolute values require a
s/one or more bytes/a variable-length encoding/

(_everything_ encodes in "one or more bytes")

i also think you can say "smaller values" rather than "numbers with smaller
absolute values".

you've been writing spec prose for too long....

[gri, 2014-10-01 22:51:57]

PTAL

https://codereview.appspot.com/153820044/diff/20001/src/encoding/binary/binar...
File src/encoding/binary/binary.go (right):

https://codereview.appspot.com/153820044/diff/20001/src/encoding/binary/binar...
src/encoding/binary/binary.go:13: // The Xvarint functions encode and decode
single integer values using
On 2014/10/01 22:36:29, r wrote:
> s/X// it adds nothing.

Done.

https://codereview.appspot.com/153820044/diff/20001/src/encoding/binary/binar...
src/encoding/binary/binary.go:14: // one or more bytes; numbers with smaller
absolute values require a
On 2014/10/01 22:36:30, r wrote:
> s/one or more bytes/a variable-length encoding/
> 
> (_everything_ encodes in "one or more bytes")
> 
> i also think you can say "smaller values" rather than "numbers with smaller
> absolute values".
> 
> you've been writing spec prose for too long....

Done.

[r, 2014-10-01 23:05:16]

LGTM

[gri, 2014-10-01 23:10:00]

*** Submitted as https://code.google.com/p/go/source/detail?r=5fe7df08d177 ***

encoding/binary: slightly better documentation

Fixes issue 7306.

LGTM=r
R=r
CC=golang-codereviews
https://codereview.appspot.com/153820044