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: documentation of supported LSP features #47306

Open
jmhodges opened this issue Jul 20, 2021 · 5 comments
Open

x/tools/gopls: documentation of supported LSP features #47306

jmhodges opened this issue Jul 20, 2021 · 5 comments
Labels
Documentation Issues describing a change to documentation. gopls Issues related to the Go language server, gopls. NeedsInvestigation Someone must examine and confirm this is a valid issue and not a duplicate of an existing one. Tools This label describes issues relating to any tools in the x/tools repository.

Comments

@jmhodges
Copy link
Contributor

I could totally believe I just wasn't able to find this (and maybe this ticket would then be for me to go make the linkages better).

It would be nice to have documentation on what features of the LSP protocol are supported (e.g. what kinds of refactoring, etc.). The rust-analyzer one is an okay version. (It's currently got a bug where its hierarchies got flattened all to one, but hopefully that'll be fixed soon)

It seems like the Features markdown file would be a good place for this

@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. labels Jul 20, 2021
@gopherbot gopherbot added this to the Unreleased milestone Jul 20, 2021
@gopherbot gopherbot added the Documentation Issues describing a change to documentation. label Jul 20, 2021
@thanm
Copy link
Contributor

thanm commented Jul 20, 2021

Would https://go.googlesource.com/tools/+/refs/heads/master/gopls/doc/commands.md be the sort of documentation you are looking for?

@jmhodges
Copy link
Contributor Author

Yeah, I do believe so! I don't see it linked in the README, which is how I missed it, I think

@jmhodges
Copy link
Contributor Author

I'm not sure if it's better to put that file into Features or to link to both from the README. I think it's better to combine them, but I'm not sure if there's some autogeneration or some such that makes that difficult or whatever.

@thanm thanm added the NeedsInvestigation Someone must examine and confirm this is a valid issue and not a duplicate of an existing one. label Jul 21, 2021
@thanm
Copy link
Contributor

thanm commented Jul 21, 2021

@stamblerre per owners

@stamblerre
Copy link
Contributor

The commands.md file specifies the supported commands through the executeCommand request, so it's not a comprehensive list. We can definitely autogenerate the set of supported features, but it's probably not something that we will prioritize for a while.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Documentation Issues describing a change to documentation. gopls Issues related to the Go language server, gopls. NeedsInvestigation Someone must examine and confirm this is a valid issue and not a duplicate of an existing one. Tools This label describes issues relating to any tools in the x/tools repository.
Projects
None yet
Development

No branches or pull requests

4 participants