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.

Sign up for GitHub

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

Jump to bottom

go/types, types2: be consistent about the words 'parameterized' vs 'generic' in error messages and documentation #49593

Closed
findleyr opened this issue Nov 15, 2021 · 8 comments
Closed

go/types, types2: be consistent about the words 'parameterized' vs 'generic' in error messages and documentation #49593

findleyr opened this issue Nov 15, 2021 · 8 comments
Assignees
@griesemer @findleyr
Labels
Documentation Issues describing a change to documentation. FrozenDueToAge NeedsDecision Feedback is required from experts, contributors, and/or the community before a change can be made.
Milestone
Go1.20

Comments

@findleyr
Copy link
Member

Reminder issue: we have some error messages that use the word 'generic', when we've been preferring 'parameterized' in most cases. We also have some instances of the word 'generic' in documentation.

We should decide on exactly when to use each word, and do an audit for consistent usage. FWIW, I sometimes prefer 'generic' because it is shorter than 'parameterized' and not liable to be confused by normal function parameters. But most important to be consistent.

Assigning the Go1.18 milestone, but this is not a release blocker.

CC @griesemer
@findleyr findleyr added the NeedsDecision Feedback is required from experts, contributors, and/or the community before a change can be made. label Nov 15, 2021
@findleyr findleyr added this to the Go1.18 milestone Nov 15, 2021
@gopherbot gopherbot added the Documentation Issues describing a change to documentation. label Nov 15, 2021
@griesemer griesemer self-assigned this Nov 15, 2021
@findleyr findleyr self-assigned this Nov 15, 2021
@findleyr
Copy link
Member Author

findleyr commented Feb 8, 2022

Just going through our 1.18 issues: we have not gotten to this yet, but should this week before the RC is cut.

@griesemer
Copy link
Contributor

We should use generic when referring to uninstantiated functions or types with type parameters. Sufficient to fix error messages, if any.

@griesemer
Copy link
Contributor

The spec now uses the term "generic" rather than "parameterized" to make it clear that we talk about type parameters (and not other function parameters).

@gopherbot
Copy link
Contributor

Change https://go.dev/cl/391154 mentions this issue: go/types, types2: clarify documentation with respect to generic types

@findleyr
Copy link
Member Author

findleyr commented Mar 9, 2022

Mailed https://go.dev/cl/391154 to address documentation.

I think any remaining error messages will have to wait until 1.19. @griesemer do you agree?

gopherbot pushed a commit that referenced this issue Mar 9, 2022
@findleyr
go/types, types2: clarify documentation with respect to generic types
e189b5e 
Address several areas where documentation was inaccurate or unclear
regarding generic types. Also prefer the use of the word 'generic' over
'parameterized', and add additional documentation for the use of
SetConstraint.

For #49593

Change-Id: Iccac60d1b3e2c45a57a3d03b3c10984293af57dd
Reviewed-on: https://go-review.googlesource.com/c/go/+/391154
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>
@dmitshur dmitshur mentioned this issue Mar 10, 2022
Closed
33 tasks
@gopherbot
Copy link
Contributor

Change https://go.dev/cl/391356 mentions this issue: [release-branch.go1.18] go/types, types2: clarify documentation with respect to generic types

@griesemer
Copy link
Contributor

Now that documentation has been updated, moving this to 1.19 for any remaining tasks.

@griesemer griesemer modified the milestones: Go1.18, Go1.19 Mar 10, 2022
gopherbot pushed a commit that referenced this issue Mar 11, 2022
@findleyr @dmitshur
[release-branch.go1.18] go/types, types2: clarify documentation with …
c6b5b7e 
…respect to generic types

Address several areas where documentation was inaccurate or unclear
regarding generic types. Also prefer the use of the word 'generic' over
'parameterized', and add additional documentation for the use of
SetConstraint.

For #49593

Change-Id: Iccac60d1b3e2c45a57a3d03b3c10984293af57dd
Reviewed-on: https://go-review.googlesource.com/c/go/+/391154
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>
(cherry picked from commit e189b5e)
Reviewed-on: https://go-review.googlesource.com/c/go/+/391356
Trust: Dmitri Shuralyov <dmitshur@golang.org>
Run-TryBot: Dmitri Shuralyov <dmitshur@golang.org>
@griesemer griesemer modified the milestones: Go1.19, Go1.20 Jun 24, 2022
@findleyr
Copy link
Member Author

We looked through error messages, and they all seem appropriate now. Closing.

@findleyr findleyr moved this to Done in Release Blockers Nov 17, 2022
@golang golang locked and limited conversation to collaborators Nov 17, 2023
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Assignees

@griesemer griesemer

@findleyr findleyr

Labels
Documentation Issues describing a change to documentation. FrozenDueToAge NeedsDecision Feedback is required from experts, contributors, and/or the community before a change can be made.
Projects
Release Blockers
Status: Done
Milestone
Go1.20
Development

No branches or pull requests
3 participants
@griesemer @gopherbot @findleyr