code review 5933049: doc: added The Go image package article

doc: added The Go image package article

Orignally published on The Go Programming Language, September 21, 2011.

http://blog.golang.org/2011/09/go-image-package.html

Update issue 2547

[fss, 2012-03-28 00:40:00]

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

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

[adg, 2012-03-28 00:51:31]

http://codereview.appspot.com/5933049/diff/6002/doc/articles/image_package.html
File doc/articles/image_package.html (right):

http://codereview.appspot.com/5933049/diff/6002/doc/articles/image_package.ht...
doc/articles/image_package.html:177: An <a href="/pkg/image/#Image">Image</a>
maps every grid square in a
why the indent here?

[fss, 2012-03-28 01:01:59]

ptal

https://codereview.appspot.com/5933049/diff/6002/doc/articles/image_package.html
File doc/articles/image_package.html (right):

https://codereview.appspot.com/5933049/diff/6002/doc/articles/image_package.h...
doc/articles/image_package.html:177: An <a href="/pkg/image/#Image">Image</a>
maps every grid square in a
On 2012/03/28 00:51:31, adg wrote:
> why the indent here?

Done.

Text editor mess.

[adg, 2012-03-28 01:11:51]

On 28 March 2012 12:01,  <franciscossouza@gmail.com> wrote:
> ptal
>
>
>
https://codereview.appspot.com/5933049/diff/6002/doc/articles/image_package.html
> File doc/articles/image_package.html (right):
>
>
https://codereview.appspot.com/5933049/diff/6002/doc/articles/image_package.h...
>
> doc/articles/image_package.html:177: An <a
> href="/pkg/image/#Image">Image</a> maps every grid square in a
> On 2012/03/28 00:51:31, adg wrote:
>>
>> why the indent here?
>
>
> Done.
>
> Text editor mess.

That's why I keep my text editors in a hutch.

[nigeltao, 2012-03-28 01:59:48]

https://codereview.appspot.com/5933049/diff/4/doc/articles/image_package.html
File doc/articles/image_package.html (right):

https://codereview.appspot.com/5933049/diff/4/doc/articles/image_package.html...
doc/articles/image_package.html:7: <a href="/pkg/image/">Package image</a>
defines a number of types:
This opening paragraph needs reworking: the image.Color and and image.ColorModel
types have been renamed to color.Color and color.Model.

I'd replace with:


The <a href="/pkg/image/">image</a> and <a
href="/pkg/image/color/">image/color</a>
packages define a number of types:
<code>color.Color</code> and <code>color.Model</code> describe colors,
<code>image.Point</code> and <code>image.Rectangle</code> describe basic 2-D
geometry, and <code>image.Image</code> brings the two concepts together to
represent a rectangular grid of colors. A
<a href="/doc/articles/image_draw.html">separate article</a> covers image
composition with the <a href="/pkg/image/draw/">image/draw</a> package.

https://codereview.appspot.com/5933049/diff/4/doc/articles/image_package.html...
doc/articles/image_package.html:55: with non-alpha-premultiplied colors, which
is why <code>color.Color</code> uses
You sometimes call things color.Foo, and other times just Foo. I would just
always call them Foo, so: s/color.Color/Color/

The opening paragraph above is the exception to this rule.

https://codereview.appspot.com/5933049/diff/4/doc/articles/image_package.html...
doc/articles/image_package.html:60: The image package also defines a number of
concrete color types that implement
s,image,image/color, and then s/concrete color types/concrete types/ reads
better.

https://codereview.appspot.com/5933049/diff/4/doc/articles/image_package.html...
doc/articles/image_package.html:62: <a
href="/pkg/image/color/#RGBA"><code>color.RGBA</code></a> is a struct that
s/color.RGBA/RGBA/

https://codereview.appspot.com/5933049/diff/4/doc/articles/image_package.html...
doc/articles/image_package.html:73: <a
href="/pkg/image/color/#NRGBA"><code>color.NRGBA</code></a> struct type
represents
s/color.NRGBA/NRGBA/

https://codereview.appspot.com/5933049/diff/4/doc/articles/image_package.html...
doc/articles/image_package.html:81: A <a
href="/pkg/image/color/#Model"><code>color.Model</code></a> is simply
s/color.Model/Model/. Similarly in this paragraph for color.Gray and
color.Palette.

https://codereview.appspot.com/5933049/diff/4/doc/articles/image_package.html...
doc/articles/image_package.html:82: something that can convert Colors to other
Colors, possibly lossily. For
The "Color"s should be "<code>Color</code>".

https://codereview.appspot.com/5933049/diff/4/doc/articles/image_package.html...
doc/articles/image_package.html:117: out their <code>Min</code> and
<code>Max</code> Points.
Points should be <code>Point</code>s.

https://codereview.appspot.com/5933049/diff/4/doc/articles/image_package.html...
doc/articles/image_package.html:223: These types also provide a <code>Set(x, y
int, c Color)</code> method that
s/Color/color.Color/

This is actual code, so the distinction matters.

https://codereview.appspot.com/5933049/diff/4/doc/articles/image_package.html...
doc/articles/image_package.html:300: _ "vp8-go.googlecode.com/hg/webp"
Change the import path to "code.google.com/p/vp8-go/webp" and move it up one
line, to maintain sortedness.

https://codereview.appspot.com/5933049/diff/4/doc/progs/image_package5.go
File doc/progs/image_package5.go (right):

https://codereview.appspot.com/5933049/diff/4/doc/progs/image_package5.go#new...
doc/progs/image_package5.go:16: 
I'd delete the blank line.

[fss, 2012-03-28 02:47:11]

ptal

https://codereview.appspot.com/5933049/diff/4/doc/articles/image_package.html
File doc/articles/image_package.html (right):

https://codereview.appspot.com/5933049/diff/4/doc/articles/image_package.html...
doc/articles/image_package.html:7: <a href="/pkg/image/">Package image</a>
defines a number of types:
On 2012/03/28 01:59:49, nigeltao wrote:
> This opening paragraph needs reworking: the image.Color and and
image.ColorModel
> types have been renamed to color.Color and color.Model.
> 
> I'd replace with:
> 
> 
> The <a href="/pkg/image/">image</a> and <a
> href="/pkg/image/color/">image/color</a>
> packages define a number of types:
> <code>color.Color</code> and <code>color.Model</code> describe colors,
> <code>image.Point</code> and <code>image.Rectangle</code> describe basic 2-D
> geometry, and <code>image.Image</code> brings the two concepts together to
> represent a rectangular grid of colors. A
> <a href="/doc/articles/image_draw.html">separate article</a> covers image
> composition with the <a href="/pkg/image/draw/">image/draw</a> package.

Done.

https://codereview.appspot.com/5933049/diff/4/doc/articles/image_package.html...
doc/articles/image_package.html:55: with non-alpha-premultiplied colors, which
is why <code>color.Color</code> uses
On 2012/03/28 01:59:49, nigeltao wrote:
> You sometimes call things color.Foo, and other times just Foo. I would just
> always call them Foo, so: s/color.Color/Color/
> 
> The opening paragraph above is the exception to this rule.

Done.

https://codereview.appspot.com/5933049/diff/4/doc/articles/image_package.html...
doc/articles/image_package.html:60: The image package also defines a number of
concrete color types that implement
On 2012/03/28 01:59:49, nigeltao wrote:
> s,image,image/color, and then s/concrete color types/concrete types/ reads
> better.

Done.

https://codereview.appspot.com/5933049/diff/4/doc/articles/image_package.html...
doc/articles/image_package.html:62: <a
href="/pkg/image/color/#RGBA"><code>color.RGBA</code></a> is a struct that
On 2012/03/28 01:59:49, nigeltao wrote:
> s/color.RGBA/RGBA/

Done.

https://codereview.appspot.com/5933049/diff/4/doc/articles/image_package.html...
doc/articles/image_package.html:73: <a
href="/pkg/image/color/#NRGBA"><code>color.NRGBA</code></a> struct type
represents
On 2012/03/28 01:59:49, nigeltao wrote:
> s/color.NRGBA/NRGBA/

Done.

https://codereview.appspot.com/5933049/diff/4/doc/articles/image_package.html...
doc/articles/image_package.html:81: A <a
href="/pkg/image/color/#Model"><code>color.Model</code></a> is simply
On 2012/03/28 01:59:49, nigeltao wrote:
> s/color.Model/Model/. Similarly in this paragraph for color.Gray and
> color.Palette.

Done.

https://codereview.appspot.com/5933049/diff/4/doc/articles/image_package.html...
doc/articles/image_package.html:82: something that can convert Colors to other
Colors, possibly lossily. For
On 2012/03/28 01:59:49, nigeltao wrote:
> The "Color"s should be "<code>Color</code>".

Done.

https://codereview.appspot.com/5933049/diff/4/doc/articles/image_package.html...
doc/articles/image_package.html:117: out their <code>Min</code> and
<code>Max</code> Points.
On 2012/03/28 01:59:49, nigeltao wrote:
> Points should be <code>Point</code>s.

Done.

https://codereview.appspot.com/5933049/diff/4/doc/articles/image_package.html...
doc/articles/image_package.html:223: These types also provide a <code>Set(x, y
int, c Color)</code> method that
On 2012/03/28 01:59:49, nigeltao wrote:
> s/Color/color.Color/
> 
> This is actual code, so the distinction matters.

Done.

https://codereview.appspot.com/5933049/diff/4/doc/articles/image_package.html...
doc/articles/image_package.html:300: _ "vp8-go.googlecode.com/hg/webp"
On 2012/03/28 01:59:49, nigeltao wrote:
> Change the import path to "code.google.com/p/vp8-go/webp" and move it up one
> line, to maintain sortedness.

Done.

https://codereview.appspot.com/5933049/diff/4/doc/progs/image_package5.go
File doc/progs/image_package5.go (right):

https://codereview.appspot.com/5933049/diff/4/doc/progs/image_package5.go#new...
doc/progs/image_package5.go:16: 
On 2012/03/28 01:59:49, nigeltao wrote:
> I'd delete the blank line.

Done.

[nigeltao, 2012-03-28 03:08:47]

LGTM.

I'll fix up the tiny typo when I submit.

https://codereview.appspot.com/5933049/diff/1020/doc/articles/image_package.html
File doc/articles/image_package.html (right):

https://codereview.appspot.com/5933049/diff/1020/doc/articles/image_package.h...
doc/articles/image_package.html:205: slice of pixel data. For example, an
s/an/a/. English is quirky in places.

[nigeltao, 2012-03-28 03:25:05]

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

doc: added The Go image package article

Orignally published on The Go Programming Language, September 21, 2011.

http://blog.golang.org/2011/09/go-image-package.html

Update issue 2547

R=adg, nigeltao
CC=golang-dev
http://codereview.appspot.com/5933049

Committer: Nigel Tao <nigeltao@golang.org>