code review 6495085: Mail related: Minor corrections to documentation comments.

Mail related: Minor corrections to documentation comments.

[lucio, 2012-09-05 06:42:55]

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

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

[dsymonds, 2012-09-05 07:10:27]

https://codereview.appspot.com/6495085/diff/5001/src/pkg/net/mail/message.go
File src/pkg/net/mail/message.go (right):

https://codereview.appspot.com/6495085/diff/5001/src/pkg/net/mail/message.go#...
src/pkg/net/mail/message.go:50: // The headers are parsed, and the body of the
message will be read from r.
The existing text is correct, and what you've changed it to is wrong. The body
is *not* read from r by this function, but rather r will be pointed at the start
of the body stream.

[lucio, 2012-09-05 08:39:27]

I guess it needs to be rephrased, then.  "will be reading from r" doesn't
parse.

Lucio.


On 9/5/12, dsymonds@golang.org <dsymonds@golang.org> wrote:
>
> https://codereview.appspot.com/6495085/diff/5001/src/pkg/net/mail/message.go
> File src/pkg/net/mail/message.go (right):
>
>
https://codereview.appspot.com/6495085/diff/5001/src/pkg/net/mail/message.go#...
> src/pkg/net/mail/message.go:50: // The headers are parsed, and the body
> of the message will be read from r.
> The existing text is correct, and what you've changed it to is wrong.
> The body is *not* read from r by this function, but rather r will be
> pointed at the start of the body stream.
>
> https://codereview.appspot.com/6495085/
>

[lucio, 2012-09-05 10:55:49]

On 2012/09/05 08:39:27, lucio wrote:
> I guess it needs to be rephrased, then.  "will be reading from r" doesn't
> parse.
> 
> Lucio.
> 
> 
> On 9/5/12, mailto:dsymonds@golang.org <mailto:dsymonds@golang.org> wrote:
> >
> > https://codereview.appspot.com/6495085/diff/5001/src/pkg/net/mail/message.go
> > File src/pkg/net/mail/message.go (right):
> >
> >
>
https://codereview.appspot.com/6495085/diff/5001/src/pkg/net/mail/message.go#...
> > src/pkg/net/mail/message.go:50: // The headers are parsed, and the body
> > of the message will be read from r.
> > The existing text is correct, and what you've changed it to is wrong.
> > The body is *not* read from r by this function, but rather r will be
> > pointed at the start of the body stream.
> >
> > https://codereview.appspot.com/6495085/
> >

Submitting a slight rephrase, but I'm not sure it captures the
essence...

Lucio.

[lucio, 2012-09-05 10:56:22]

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

Please take another look.

[dsymonds, 2012-09-06 05:18:32]

I'm going to punt to someone with superior wordsmith skills.

[gobot, 2012-09-06 05:18:42]

R=r (assigned by dsymonds)

[r, 2012-09-07 17:23:30]

LGTM

[r, 2012-09-07 17:25:01]

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

net,mime: Minor corrections to documentation comments.

R=r
CC=dsymonds, gobot, golang-dev
http://codereview.appspot.com/6495085

Committer: Rob Pike <r@golang.org>