code review 5626050: image: add package docs, rename s/UnknownFormatError/Er...

image: add package docs, rename s/UnknownFormatError/ErrFormat/ and
rewrite the doc comment for Repeated.

Fixes issue 2858.

[nigeltao, 2012-02-04 01:36:55]

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

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

[nigeltao, 2012-02-04 01:40:54]

http://codereview.appspot.com/5626050/diff/3001/src/pkg/image/names.go
File src/pkg/image/names.go (right):

http://codereview.appspot.com/5626050/diff/3001/src/pkg/image/names.go#newcode62
src/pkg/image/names.go:62: // Offset is the translation vector from result pixel
to source pixel.
This is arguably backwards, in that an offset should be src-to-dst instead of
dst-to-src, but changing that is out of scope for this CL, and probably not
happening for Go 1.

[r, 2012-02-05 01:00:51]

http://codereview.appspot.com/5626050/diff/3001/src/pkg/image/image.go
File src/pkg/image/image.go (right):

http://codereview.appspot.com/5626050/diff/3001/src/pkg/image/image.go#newcode16
src/pkg/image/image.go:16: // `import _ "image/png"` in a program's main
package.
strange formatting. the `` are confusing.
probably worth explaining that the _ is important.

http://codereview.appspot.com/5626050/diff/3001/src/pkg/image/image.go#newcode18
src/pkg/image/image.go:18: // See "The Go image package" for more detail:
s/detail/&s/ (american usage)

http://codereview.appspot.com/5626050/diff/3001/src/pkg/image/image.go#newcode32
src/pkg/image/image.go:32: // Image is a finite rectangular grid of color.Color
values drawn from a color
"drawn from" has two meanings

[nigeltao, 2012-02-05 23:29:10]

http://codereview.appspot.com/5626050/diff/3001/src/pkg/image/image.go
File src/pkg/image/image.go (right):

http://codereview.appspot.com/5626050/diff/3001/src/pkg/image/image.go#newcode16
src/pkg/image/image.go:16: // `import _ "image/png"` in a program's main
package.
On 2012/02/05 01:00:51, r wrote:
> strange formatting. the `` are confusing.
> probably worth explaining that the _ is important.

Done.

http://codereview.appspot.com/5626050/diff/3001/src/pkg/image/image.go#newcode18
src/pkg/image/image.go:18: // See "The Go image package" for more detail:
On 2012/02/05 01:00:51, r wrote:
> s/detail/&s/ (american usage)

Done.

http://codereview.appspot.com/5626050/diff/3001/src/pkg/image/image.go#newcode32
src/pkg/image/image.go:32: // Image is a finite rectangular grid of color.Color
values drawn from a color
On 2012/02/05 01:00:51, r wrote:
> "drawn from" has two meanings

Done.

[r, 2012-02-05 23:47:30]

LGTM

[nigeltao, 2012-02-06 00:04:18]

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

image: add package docs, rename s/UnknownFormatError/ErrFormat/ and
rewrite the doc comment for Repeated.

Fixes issue 2858.

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