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

cmd/doc, go/doc: update for generics #49210

Closed
findleyr opened this issue Oct 28, 2021 · 2 comments
Closed

cmd/doc, go/doc: update for generics #49210

findleyr opened this issue Oct 28, 2021 · 2 comments
Labels
NeedsFix The path to resolution is known, but the work has not been done. release-blocker
Milestone

Comments

@findleyr
Copy link
Contributor

Belated tracking issue: go/doc and cmd/doc needs to be updated for generics. @jba and I have an in-progress CL to do this.

@findleyr findleyr added NeedsFix The path to resolution is known, but the work has not been done. release-blocker labels Oct 28, 2021
@findleyr findleyr added this to the Go1.18 milestone Oct 28, 2021
@findleyr findleyr self-assigned this Oct 28, 2021
@gopherbot
Copy link

Change https://golang.org/cl/359778 mentions this issue: cmd/doc, go/doc: add basic support for generic code

gopherbot pushed a commit that referenced this issue Nov 4, 2021
Update cmd/doc and go/doc for the generics, by adding handling for type
parameters and the new embedded interface elements.

Specifically:
 - Format type parameters when summarizing type and function nodes.
 - Find the origin type name for instantiation expressions, so that
   methods are associated with generic type declarations.
 - Generalize the handling of embedding 'error' in interfaces to
   arbitrary predeclared types.
 - Keep embedded type literals.
 - Update filtering to descend into embedded type literals.

Also add "any" to the list of predeclared types.

Updates #49210

Change-Id: I6ea82869f19c3cdbc3c842f01581c8fc7e1c2ee7
Reviewed-on: https://go-review.googlesource.com/c/go/+/359778
Trust: Robert Findley <rfindley@google.com>
Run-TryBot: Robert Findley <rfindley@google.com>
TryBot-Result: Go Bot <gobot@golang.org>
Reviewed-by: Robert Griesemer <gri@golang.org>
@findleyr
Copy link
Contributor Author

findleyr commented Nov 8, 2021

Closing this release blocker, since we should now support generic code in go/doc and cmd/doc. But historically go/doc changes have been subtle. @jba will be updating pkgsite, which contains a fork, and may file additional issues as needed.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
NeedsFix The path to resolution is known, but the work has not been done. release-blocker
Projects
None yet
Development

No branches or pull requests

2 participants