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/tools/gopls: add a mechanism for marking a setting deprecated in documentation #42107

Open
stamblerre opened this issue Oct 21, 2020 · 1 comment
Labels
Documentation gopls Issues related to the Go language server, gopls. Tools This label describes issues relating to any tools in the x/tools repository.
Milestone

Comments

@stamblerre
Copy link
Contributor

stamblerre commented Oct 21, 2020

We currently have a way of notifying users that they are using a deprecated setting, but it would also be nice to mark the deprecation in the documentation. This way, we could surface the deprecation in the package.json and smoothly transition users off of an outdated setting.

/cc @heschik @hyangah

Edit: This would be doable by adding a struct tag that sets a field's status to "deprecated". We could then use reflection to check the field's status when setting it. However, we should probably only do this once we set all options using reflection, which is a big enough change that we shouldn't do it until after February.

@stamblerre stamblerre added this to the gopls/v1.0.0 milestone Oct 21, 2020
@gopherbot gopherbot added Tools This label describes issues relating to any tools in the x/tools repository. gopls Issues related to the Go language server, gopls. Documentation labels Oct 21, 2020
@stamblerre stamblerre added this to Needs Triage in vscode-go: gopls by default Nov 10, 2020
@stamblerre stamblerre moved this from Needs Triage to Non-critical in vscode-go: gopls by default Nov 10, 2020
@stamblerre stamblerre moved this from Non-critical to Documentation in vscode-go: gopls by default Nov 10, 2020
@stamblerre stamblerre removed this from Documentation in vscode-go: gopls by default Dec 26, 2020
@stamblerre stamblerre added this to To Do in gopls on-deck Feb 28, 2021
@findleyr
Copy link
Contributor

findleyr commented Jan 19, 2022

This is not urgent, but should be straightforward and would be nice to do before we move configuration around. Tentatively putting in the v0.8.0 milestone.

@findleyr findleyr modified the milestones: gopls/on-deck, gopls/v0.8.0 Jan 19, 2022
@findleyr findleyr modified the milestones: gopls/v0.8.0, gopls/v0.8.1 Feb 11, 2022
@findleyr findleyr modified the milestones: gopls/v0.8.1, gopls/v0.8.2 Mar 7, 2022
@findleyr findleyr modified the milestones: gopls/v0.8.2, gopls/on-deck Mar 24, 2022
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Documentation gopls Issues related to the Go language server, gopls. Tools This label describes issues relating to any tools in the x/tools repository.
Projects
No open projects
Development

No branches or pull requests

3 participants