code review 7235080: reflect: explain StructField.Anonymous field as 'embedded'

reflect: explain StructField.Anonymous field as 'embedded'

The spec mostly uses the term embedded.
It's too late to change the field name but at least fix the docs.

Fixes issue 4514.

[rsc, 2013-02-01 19:44:11]

Hello golang-dev@googlegroups.com,

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

[dave_cheney.net, 2013-02-01 21:17:55]

LGTM. Would you consider it appropriate to add something like

+// BUG(rsc): StructField.Anonymous should be called Embedded but cannot
+// be changed during the lifetime of Go 1.

to document this, possibly as a reminder to clean this up in a future
version of Go ?

On Sat, Feb 2, 2013 at 6:44 AM,  <rsc@golang.org> wrote:
> Reviewers: golang-dev_googlegroups.com,
>
> Message:
> Hello golang-dev@googlegroups.com,
>
> I'd like you to review this change to
> https://code.google.com/p/go/
>
>
> Description:
> reflect: explain StructField.Anonymous field as 'embedded'
>
> The spec mostly uses the term embedded.
> It's too late to change the field name but at least fix the docs.
>
> Fixes issue 4514.
>
> Please review this at https://codereview.appspot.com/7235080/
>
> Affected files:
>   M src/pkg/reflect/type.go
>
>
> Index: src/pkg/reflect/type.go
> ===================================================================
> --- a/src/pkg/reflect/type.go
> +++ b/src/pkg/reflect/type.go
> @@ -708,7 +708,7 @@
>         Tag       StructTag // field tag string
>         Offset    uintptr   // offset within struct, in bytes
>         Index     []int     // index sequence for Type.FieldByIndex
> -       Anonymous bool      // is an anonymous field
> +       Anonymous bool      // is an embedded field
>  }
>
>  // A StructTag is the tag string in a struct field.
>
>
> --
>
> ---You received this message because you are subscribed to the Google Groups
> "golang-dev" group.
> To unsubscribe from this group and stop receiving emails from it, send an
> email to golang-dev+unsubscribe@googlegroups.com.
> For more options, visit https://groups.google.com/groups/opt_out.
>
>

[rsc, 2013-02-02 02:00:34]

On Fri, Feb 1, 2013 at 1:17 PM, Dave Cheney <dave@cheney.net> wrote:

> +// BUG(rsc): StructField.Anonymous should be called Embedded but cannot
> +// be changed during the lifetime of Go 1.
>
> to document this, possibly as a reminder to clean this up in a future
> version of Go ?
>

I'd rather not. I hope that even when we have the opportunity to introduce
incompatibilities in Go 2 we will refrain from introducing unnecessary
ones. Anonymous fields are still a term that get used in Go.

Russ

[rsc, 2013-02-02 02:01:50]

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

reflect: explain StructField.Anonymous field as 'embedded'

The spec mostly uses the term embedded.
It's too late to change the field name but at least fix the docs.

Fixes issue 4514.

R=golang-dev, dave
CC=golang-dev
https://codereview.appspot.com/7235080