code review 5322067: builtin: document the basic types

builtin: document the basic types
The recursive definitions are illegal Go, but godoc doesn't mind.

[r, 2011-11-02 18:16:46]

Hello golang-dev@googlegroups.com,

I'd like you to review this change to
https://go.googlecode.com/hg/

[r, 2011-11-02 18:18:34]

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

Please take another look.

[r, 2011-11-02 18:19:17]

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

Please take another look.

[bradfitz, 2011-11-02 18:23:58]

http://codereview.appspot.com/5322067/diff/6001/src/pkg/builtin/builtin.go
File src/pkg/builtin/builtin.go (right):

http://codereview.appspot.com/5322067/diff/6001/src/pkg/builtin/builtin.go#ne...
src/pkg/builtin/builtin.go:16: // uint8 is the set of all unsigned  8-bit
integers (0 to 255).
Maybe drop the parens and precede with a command instead, so they don't look
like exclusive bounds?

http://codereview.appspot.com/5322067/diff/6001/src/pkg/builtin/builtin.go#ne...
src/pkg/builtin/builtin.go:52: // string is the set of all text strings. A
string may be empty, but not nil.
"text"?  it may be binary.  it doesn't even have to be UTF-8, though
conventionally it is.

http://codereview.appspot.com/5322067/diff/6001/src/pkg/builtin/builtin.go#ne...
src/pkg/builtin/builtin.go:60: // uintptr is an integer type that is large
enough to hold the bit pattern of any pointer.
80 chars

http://codereview.appspot.com/5322067/diff/6001/src/pkg/builtin/builtin.go#ne...
src/pkg/builtin/builtin.go:64: // It is used, by convention, to distinguish byte
values from 8-bit unsigned integer values.
80

[r, 2011-11-02 18:29:41]

Hello golang-dev@googlegroups.com, bradfitz@golang.org (cc:
golang-dev@googlegroups.com),

Please take another look.

[bradfitz, 2011-11-02 18:36:01]

LGTM

http://codereview.appspot.com/5322067/diff/4003/src/pkg/builtin/builtin.go
File src/pkg/builtin/builtin.go (right):

http://codereview.appspot.com/5322067/diff/4003/src/pkg/builtin/builtin.go#ne...
src/pkg/builtin/builtin.go:16: // uint8 is the set of all unsigned  8-bit
integers.
two spaces

http://codereview.appspot.com/5322067/diff/4003/src/pkg/builtin/builtin.go#ne...
src/pkg/builtin/builtin.go:32: // int8 is the set of all signed  8-bit integers.
also two spaces

[r, 2011-11-02 18:37:44]

Hello golang-dev@googlegroups.com, bradfitz@golang.org (cc:
golang-dev@googlegroups.com),

Please take another look.

[r2, 2011-11-02 18:37:52]

all done. anyone else?

[niemeyer, 2011-11-02 18:39:35]

http://codereview.appspot.com/5322067/diff/3003/src/pkg/builtin/builtin.go
File src/pkg/builtin/builtin.go (right):

http://codereview.appspot.com/5322067/diff/3003/src/pkg/builtin/builtin.go#ne...
src/pkg/builtin/builtin.go:67: // uintptr is an unsigned integer type that is at
least 32 bits in size. It
s/uintptr/int/

[r, 2011-11-02 18:40:15]

Hello golang-dev@googlegroups.com, bradfitz@golang.org, r@google.com,
n13m3y3r@gmail.com (cc: golang-dev@googlegroups.com),

Please take another look.

[niemeyer, 2011-11-02 18:43:06]

http://codereview.appspot.com/5322067/diff/9002/src/pkg/builtin/builtin.go
File src/pkg/builtin/builtin.go (right):

http://codereview.appspot.com/5322067/diff/9002/src/pkg/builtin/builtin.go#ne...
src/pkg/builtin/builtin.go:68: // distinct type, however, and not an alias for,
say, int32.
Sorry, also s/unsigned//.. and it looks like the actual uint type is missing?

[r2, 2011-11-02 18:44:23]

indeed, uint. i remembered uintptr though.

PTAL

[rsc, 2011-11-02 18:58:15]

LGTM

http://codereview.appspot.com/5322067/diff/19001/src/pkg/builtin/builtin.go
File src/pkg/builtin/builtin.go (right):

http://codereview.appspot.com/5322067/diff/19001/src/pkg/builtin/builtin.go#n...
src/pkg/builtin/builtin.go:69: type uint uint
s/uint/int/g

http://codereview.appspot.com/5322067/diff/19001/src/pkg/builtin/builtin.go#n...
src/pkg/builtin/builtin.go:73: type int int
s/int/uint/g

http://codereview.appspot.com/5322067/diff/19001/src/pkg/builtin/builtin.go#n...
src/pkg/builtin/builtin.go:84: // rune is alias for int and is equivalent to int
in all ways. It is used,
s/is/is an/

[r2, 2011-11-02 18:59:26]

On Nov 2, 2011, at 11:58 AM, rsc@golang.org wrote:

> LGTM
> 
> 
> 
> http://codereview.appspot.com/5322067/diff/19001/src/pkg/builtin/builtin.go
> File src/pkg/builtin/builtin.go (right):
> 
>
http://codereview.appspot.com/5322067/diff/19001/src/pkg/builtin/builtin.go#n...
> src/pkg/builtin/builtin.go:69: type uint uint
> s/uint/int/g

ha ha ha

> 
>
http://codereview.appspot.com/5322067/diff/19001/src/pkg/builtin/builtin.go#n...
> src/pkg/builtin/builtin.go:73: type int int
> s/int/uint/g
> 
>
http://codereview.appspot.com/5322067/diff/19001/src/pkg/builtin/builtin.go#n...
> src/pkg/builtin/builtin.go:84: // rune is alias for int and is
> equivalent to int in all ways. It is used,
> s/is/is an/
> 
> http://codereview.appspot.com/5322067/

[r, 2011-11-02 19:06:40]

*** Submitted as http://code.google.com/p/go/source/detail?r=3dd5a0ccc0e0 ***

builtin: document the basic types
The recursive definitions are illegal Go, but godoc doesn't mind.

R=bradfitz, r, n13m3y3r, rsc
CC=golang-dev
http://codereview.appspot.com/5322067