Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

go/types: documentation needs to be updated #50676

Open
griesemer opened this issue Jan 18, 2022 · 5 comments
Open

go/types: documentation needs to be updated #50676

griesemer opened this issue Jan 18, 2022 · 5 comments
Assignees
Labels
Documentation generics Issue is related to generics
Milestone

Comments

@griesemer
Copy link
Contributor

griesemer commented Jan 18, 2022

The documentation on go/types needs to be updated for generics: https://github.com/golang/example/tree/master/gotypes

At the very least it should point out what's not yet documented with respect to generics.

cc: @findleyr

@griesemer griesemer added Documentation generics Issue is related to generics labels Jan 18, 2022
@griesemer griesemer added this to the Go1.18 milestone Jan 18, 2022
@findleyr
Copy link
Contributor

The guide that I'm working on (starting with https://go-review.googlesource.com/c/tools/+/377834) is based on x/example/gotypes. I plan to both have the separate guide for 1.18, and integrate aspects of this into x/example/gotypes proper.

@findleyr findleyr self-assigned this Jan 18, 2022
@gopherbot
Copy link

Change https://go.dev/cl/389656 mentions this issue: gotypes: add a link to the 1.18 API guide, and fix links

gopherbot pushed a commit to golang/example that referenced this issue Mar 4, 2022
Update the go/types guide to have a link to the new 1.18 API guide, for
now.

Also fix some links to pkg.go.dev and golang.org/x that were amended in
the autogenerated README.md rather than the original source.

For golang/go#50676

Change-Id: Ib98ed095d74be02046c426e51f1ae2b9ceb03b0d
Reviewed-on: https://go-review.googlesource.com/c/example/+/389656
Trust: Robert Findley <rfindley@google.com>
Run-TryBot: Robert Findley <rfindley@google.com>
Reviewed-by: Robert Griesemer <gri@golang.org>
TryBot-Result: Gopher Robot <gobot@golang.org>
@findleyr findleyr modified the milestones: Go1.18, Go1.19 Mar 10, 2022
@ianlancetaylor
Copy link
Contributor

Are we going to do something here for 1.19? Thanks.

@findleyr
Copy link
Contributor

findleyr commented Jul 6, 2022

This documentation is in x/example; no need to associate with 1.19.

@findleyr findleyr modified the milestones: Go1.19, Go1.20 Jul 6, 2022
HadesHappy added a commit to HadesHappy/example that referenced this issue Aug 2, 2022
Update the go/types guide to have a link to the new 1.18 API guide, for
now.

Also fix some links to pkg.go.dev and golang.org/x that were amended in
the autogenerated README.md rather than the original source.

For golang/go#50676

Change-Id: Ib98ed095d74be02046c426e51f1ae2b9ceb03b0d
Reviewed-on: https://go-review.googlesource.com/c/example/+/389656
Trust: Robert Findley <rfindley@google.com>
Run-TryBot: Robert Findley <rfindley@google.com>
Reviewed-by: Robert Griesemer <gri@golang.org>
TryBot-Result: Gopher Robot <gobot@golang.org>
@findleyr
Copy link
Contributor

At some point Alan and I should update x/example, but it is unfortunately not a high priority. Moving to the backlog.

@findleyr findleyr modified the milestones: Go1.20, Backlog Oct 12, 2022
softdev050 added a commit to softdev050/golangproject that referenced this issue Apr 5, 2023
Update the go/types guide to have a link to the new 1.18 API guide, for
now.

Also fix some links to pkg.go.dev and golang.org/x that were amended in
the autogenerated README.md rather than the original source.

For golang/go#50676

Change-Id: Ib98ed095d74be02046c426e51f1ae2b9ceb03b0d
Reviewed-on: https://go-review.googlesource.com/c/example/+/389656
Trust: Robert Findley <rfindley@google.com>
Run-TryBot: Robert Findley <rfindley@google.com>
Reviewed-by: Robert Griesemer <gri@golang.org>
TryBot-Result: Gopher Robot <gobot@golang.org>
sayjun0505 added a commit to sayjun0505/golangproject that referenced this issue Apr 8, 2023
Update the go/types guide to have a link to the new 1.18 API guide, for
now.

Also fix some links to pkg.go.dev and golang.org/x that were amended in
the autogenerated README.md rather than the original source.

For golang/go#50676

Change-Id: Ib98ed095d74be02046c426e51f1ae2b9ceb03b0d
Reviewed-on: https://go-review.googlesource.com/c/example/+/389656
Trust: Robert Findley <rfindley@google.com>
Run-TryBot: Robert Findley <rfindley@google.com>
Reviewed-by: Robert Griesemer <gri@golang.org>
TryBot-Result: Gopher Robot <gobot@golang.org>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Documentation generics Issue is related to generics
Projects
Status: No status
Development

No branches or pull requests

5 participants