code review 9408044: image: minor update of comments.

image: minor update of comments.

[u, 2013-05-14 10:26:16]

Hello golang-dev@googlegroups.com,

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

[iant, 2013-05-14 13:39:35]

https://codereview.appspot.com/9408044/diff/5001/src/pkg/image/format.go
File src/pkg/image/format.go (right):

https://codereview.appspot.com/9408044/diff/5001/src/pkg/image/format.go#newc...
src/pkg/image/format.go:50: // match returns whether magic matches b. Magic may
contain "?" wildcards.
Sentences should start with capital letters.  Sticking with "Match" is fine, or
else we need a circumlocution like "The match function."

[bradfitz, 2013-05-14 13:45:20]

On Tue, May 14, 2013 at 6:39 AM, <iant@golang.org> wrote:

>
> https://codereview.appspot.**com/9408044/diff/5001/src/pkg/**
>
image/format.go<https://codereview.appspot.com/9408044/diff/5001/src/pkg/image/format.go>
> File src/pkg/image/format.go (right):
>
> https://codereview.appspot.**com/9408044/diff/5001/src/pkg/**
>
image/format.go#newcode50<https://codereview.appspot.com/9408044/diff/5001/src/pkg/image/format.go#newcode50>
> src/pkg/image/format.go:50: // match returns whether magic matches b.
>
> Magic may contain "?" wildcards.
> Sentences should start with capital letters.  Sticking with "Match" is
> fine, or else we need a circumlocution like "The match function."
>

I don't think we're consistent on this anyway. We regularly start sentences
with lowercase subjects when they're private.

But I also don't think this is worth changing. It's clear either way.

[u, 2013-05-14 15:07:24]

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

Please take another look.

[nigeltao, 2013-05-14 20:26:38]

LGTM.

https://codereview.appspot.com/9408044/diff/15001/src/pkg/image/format.go
File src/pkg/image/format.go (right):

https://codereview.appspot.com/9408044/diff/15001/src/pkg/image/format.go#new...
src/pkg/image/format.go:76: // Format registration is typically done by the init
function of the codec-
"the init" should also be "an init". I'll make the change and submit.

[nigeltao, 2013-05-14 20:28:24]

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

image: minor update of comments.

R=golang-dev, iant, bradfitz, nigeltao
CC=golang-dev
https://codereview.appspot.com/9408044

Committer: Nigel Tao <nigeltao@golang.org>