code review 10679047: go/ast: improve doc for FuncDecl's Type field.

go/ast: improve doc for FuncDecl's Type field.

[dsymonds, 2013-06-28 06:25:59]

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

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

[r, 2013-06-28 14:17:36]

LGTM

[gri, 2013-06-28 16:06:19]

https://codereview.appspot.com/10679047/diff/2002/src/pkg/go/ast/ast.go
File src/pkg/go/ast/ast.go (right):

https://codereview.appspot.com/10679047/diff/2002/src/pkg/go/ast/ast.go#newco...
src/pkg/go/ast/ast.go:923: Type *FuncType     // func keyword, parameters and
results
actually, I think what was before is more in sync w/ the rest of the code

// position of "func" keyword, parameters, and results

[r, 2013-06-28 16:11:50]

https://codereview.appspot.com/10679047/diff/2002/src/pkg/go/ast/ast.go
File src/pkg/go/ast/ast.go (right):

https://codereview.appspot.com/10679047/diff/2002/src/pkg/go/ast/ast.go#newco...
src/pkg/go/ast/ast.go:923: Type *FuncType     // func keyword, parameters and
results
On 2013/06/28 16:06:19, gri wrote:
> actually, I think what was before is more in sync w/ the rest of the code
> 
> // position of "func" keyword, parameters, and results
> 

it's not a position though, it's the type.

[gri, 2013-06-28 16:36:33]

https://codereview.appspot.com/10679047/diff/2002/src/pkg/go/ast/ast.go
File src/pkg/go/ast/ast.go (right):

https://codereview.appspot.com/10679047/diff/2002/src/pkg/go/ast/ast.go#newco...
src/pkg/go/ast/ast.go:923: Type *FuncType     // func keyword, parameters and
results
On 2013/06/28 16:11:50, r wrote:
> On 2013/06/28 16:06:19, gri wrote:
> > actually, I think what was before is more in sync w/ the rest of the code
> > 
> > // position of "func" keyword, parameters, and results
> > 
> 
> it's not a position though, it's the type.

*FuncType holds the position of "func" , the parameters, and the results

[r, 2013-06-28 16:44:50]

https://codereview.appspot.com/10679047/diff/2002/src/pkg/go/ast/ast.go
File src/pkg/go/ast/ast.go (right):

https://codereview.appspot.com/10679047/diff/2002/src/pkg/go/ast/ast.go#newco...
src/pkg/go/ast/ast.go:923: Type *FuncType     // func keyword, parameters and
results
ah, so it is very confusing.  let's get it right

// function signature: parameters, results, and position of "func" keyword

[dsymonds, 2013-06-29 02:15:32]

https://codereview.appspot.com/10679047/diff/2002/src/pkg/go/ast/ast.go
File src/pkg/go/ast/ast.go (right):

https://codereview.appspot.com/10679047/diff/2002/src/pkg/go/ast/ast.go#newco...
src/pkg/go/ast/ast.go:923: Type *FuncType     // func keyword, parameters and
results
On 2013/06/28 16:44:50, r wrote:
> ah, so it is very confusing.  let's get it right
> 
> // function signature: parameters, results, and position of "func" keyword

Done.

[gri, 2013-07-02 18:09:51]

LGTM

(though I don't see much difference from before :-)

[dsymonds, 2013-07-02 22:01:33]

On 3 July 2013 04:09,  <gri@golang.org> wrote:

> (though I don't see much difference from before :-)

Before it said:
  // position of Func keyword, parameters and results

which had ambiguous association. Is that the position of the func
keyword, and also the position of the parameters and position of the
results? (No, but it could be read that way.) The new version does not
have that ambiguity.

[gri, 2013-07-02 22:12:10]

ah! it's like one of those pictures tricking the brain: once seen, one
cannot unsee it anymore.


On Tue, Jul 2, 2013 at 3:01 PM, David Symonds <dsymonds@golang.org> wrote:

> On 3 July 2013 04:09,  <gri@golang.org> wrote:
>
> > (though I don't see much difference from before :-)
>
> Before it said:
>   // position of Func keyword, parameters and results
>
> which had ambiguous association. Is that the position of the func
> keyword, and also the position of the parameters and position of the
> results? (No, but it could be read that way.) The new version does not
> have that ambiguity.
>

[dsymonds, 2013-07-02 22:15:46]

I'm pleased to have broken your brain today.

[dsymonds, 2013-07-02 22:16:15]

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

go/ast: improve doc for FuncDecl's Type field.

R=gri, r
CC=golang-dev
https://codereview.appspot.com/10679047