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

x/website: FAQ needs to have a preamble re: generics #49938

Closed
griesemer opened this issue Dec 3, 2021 · 9 comments
Closed

x/website: FAQ needs to have a preamble re: generics #49938

griesemer opened this issue Dec 3, 2021 · 9 comments
Labels
Documentation early-in-cycle A change that should be done early in the 3 month dev cycle. FrozenDueToAge NeedsFix The path to resolution is known, but the work has not been done. release-blocker
Milestone

Comments

@griesemer
Copy link
Contributor

The FAQ need to be updated with a preamble/disclaimer as it was not written with generics in mind.

@griesemer griesemer added Documentation release-blocker okay-after-beta1 Used by release team to mark a release-blocker issue as okay to resolve either before or after beta1 labels Dec 3, 2021
@griesemer griesemer added this to the Go1.18 milestone Dec 3, 2021
@griesemer
Copy link
Contributor Author

cc: @robpike

@mknyszek mknyszek added the NeedsFix The path to resolution is known, but the work has not been done. label Dec 3, 2021
@robpike
Copy link
Contributor

robpike commented Dec 3, 2021

It needs more of an update than a preamble. The FAQ should stay current.

@cherrymui cherrymui removed the okay-after-beta1 Used by release team to mark a release-blocker issue as okay to resolve either before or after beta1 label Dec 14, 2021
@amnonbc
Copy link

amnonbc commented Dec 16, 2021

https://go.dev/doc/faq#generics should be updated.

@gopherbot
Copy link

Change https://golang.org/cl/374215 mentions this issue: _content/doc/faq: add a couple of generics FAQs

@ianlancetaylor
Copy link
Contributor

There is a CL for this that is waiting for review (https://go.dev/cl/374215). The CL won't be committed until the release.

@dmitshur
Copy link
Contributor

dmitshur commented Feb 9, 2022

@ianlancetaylor Since the CL resolving this issue is planned to be submitted right after 1.18 is released, is it okay to move this issue to 1.19 milestone, keep release-blocker label, and add early-in-cycle, so that we can revisit this right after 1.18 is released? That way, the list of open 1.18 release blockers will be more actionable.

@ianlancetaylor
Copy link
Contributor

Sure, I will make those changes.

@ianlancetaylor ianlancetaylor modified the milestones: Go1.18, Go1.19 Feb 9, 2022
@ianlancetaylor ianlancetaylor added the early-in-cycle A change that should be done early in the 3 month dev cycle. label Feb 9, 2022
@fzipp
Copy link
Contributor

fzipp commented Feb 11, 2022

Re CL 374215:

Are the comparisons with other languages necessary at all? The FAQ doesn't do that to this extent for other language features. Maybe their relevant contents can be formulated as part of other questions or as questions about specific features on their own, which is conceptually more in line with the rest of the FAQ. For example:

  • The Java comparison mentions the absence of type erasure, which could be covered by "How are generics implemented in Go?".
  • The lack of variance could be covered by a separate question: "Why are there no generic covariance and contravariance?"

The comparisons tell more about other languages than about what Go does. The Python comparison does not say anything directly about Go at all.

@ianlancetaylor
Copy link
Contributor

Personally I think the comparisons to other languages are useful, as they help explain the new features to people already familiar with those other languages. At least, I hope they do.

passionSeven added a commit to passionSeven/website that referenced this issue Oct 18, 2022
Also update the existing generics FAQ.

For golang/go#48274
Fixes golang/go#49938

Change-Id: Id87dbf43f4a151abb7c2c2f6309fc8ee3c947aa1
Reviewed-on: https://go-review.googlesource.com/c/website/+/374215
Reviewed-by: Russ Cox <rsc@golang.org>
Run-TryBot: Dmitri Shuralyov <dmitshur@google.com>
Trust: DO NOT USE <iant@google.com>
TryBot-Result: Gopher Robot <gobot@golang.org>
@golang golang locked and limited conversation to collaborators Mar 15, 2023
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Labels
Documentation early-in-cycle A change that should be done early in the 3 month dev cycle. FrozenDueToAge 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

9 participants