code review 11057043: guiltin: document print and println

builtin: document print and println

Fixes issue 5787.

[gri, 2013-07-09 20:48:24]

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

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

[r, 2013-07-09 22:06:01]

what is the guiltin package? sounds bad....

https://codereview.appspot.com/11057043/diff/1/src/pkg/builtin/builtin.go
File src/pkg/builtin/builtin.go (right):

https://codereview.appspot.com/11057043/diff/1/src/pkg/builtin/builtin.go#new...
src/pkg/builtin/builtin.go:240: // specific way. Print is useful for
bootstrapping and debugging; it is
Spaces are added between operands when neither is a string.

https://codereview.appspot.com/11057043/diff/1/src/pkg/builtin/builtin.go#new...
src/pkg/builtin/builtin.go:241: // not guaranteed to stay in the language.
say that it prints to standard error.

https://codereview.appspot.com/11057043/diff/1/src/pkg/builtin/builtin.go#new...
src/pkg/builtin/builtin.go:245: // between arguments and a newline at the end.
Spaces are always added between operands and a newline is appended.

[r, 2013-07-09 22:09:41]

have a look at how Println and Print are described in fmt. just copy
the text, amended as appropriate

[gri, 2013-07-09 22:29:40]

PTAL

https://codereview.appspot.com/11057043/diff/1/src/pkg/builtin/builtin.go
File src/pkg/builtin/builtin.go (right):

https://codereview.appspot.com/11057043/diff/1/src/pkg/builtin/builtin.go#new...
src/pkg/builtin/builtin.go:240: // specific way. Print is useful for
bootstrapping and debugging; it is
On 2013/07/09 22:06:01, r wrote:
> Spaces are added between operands when neither is a string.

This is not what print does: print(1, 2, 3) prints 123

https://codereview.appspot.com/11057043/diff/1/src/pkg/builtin/builtin.go#new...
src/pkg/builtin/builtin.go:241: // not guaranteed to stay in the language.
On 2013/07/09 22:06:01, r wrote:
> say that it prints to standard error.

Done.

https://codereview.appspot.com/11057043/diff/1/src/pkg/builtin/builtin.go#new...
src/pkg/builtin/builtin.go:245: // between arguments and a newline at the end.
On 2013/07/09 22:06:01, r wrote:
> Spaces are always added between operands and a newline is appended.

Done.

[r, 2013-07-09 23:16:05]

LGTM after the edits

https://codereview.appspot.com/11057043/diff/7002/src/pkg/builtin/builtin.go
File src/pkg/builtin/builtin.go (right):

https://codereview.appspot.com/11057043/diff/7002/src/pkg/builtin/builtin.go#...
src/pkg/builtin/builtin.go:239: // The print built-in function formats in an
implementation-specific way
formats its arguments
(here and in println)

https://codereview.appspot.com/11057043/diff/7002/src/pkg/builtin/builtin.go#...
src/pkg/builtin/builtin.go:240: // and writes to standard error.
writes the result
(here and in println)

[gri, 2013-07-09 23:20:22]

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

builtin: document print and println

Fixes issue 5787.

R=r
CC=golang-dev
https://codereview.appspot.com/11057043