Change https://go.dev/cl/577235 mentions this issue: gopls: added method docs to hover info

from

To

Change https://go.dev/cl/577356 mentions this issue: gopls: added method docs to hover info

I suspect this change could make the hover popup very long indeed.

Also, one typically needs just a brief reminder of which methods are available on the type. If you need to study the methods more closely, you can jump to their definition, or (in the forthcoming release) open the documentation for the type.

P.S. thanks for sending a potential fix, but in the future it's really worth discussing the desired behavior before starting to write code.

@adonovan I was only looking at the slack channel for response on this, I sincerely did'nt notice you have said something here 4 days ago. Thanks for taking the time.

Regarding your earlier comment, I can summarize your concerns into 2: Performance and Utility, correct?.

Regarding performance, I did not notice any difference (from my computer here, which is entirely not enough 😆), but if there is a way to benchmark or show something tangible to convince you instead, please let me know.

In the case of it utility, I actually borrowed the feature from a popular Go IDE (you know which, refrainning from naming), which is quite helpful and useful for me (also not enough, lot of people use Gopls). If it utility, I cannot argue for much I'll suppose.

If it only performance, please let me know how to go about it.

P.S. thanks for sending a potential fix, but in the future it's really worth discussing the desired behavior before starting to write code.
I was just too excited I guess, digging into Go internals, for next time... I would have this in mind.

Regarding your earlier comment, I can summarize your concerns into 2: Performance and Utility, correct?.

My concern was only about the user experience; I don't expect performance to be a problem. The complete documentation for all the methods of a type seems like a lot of information to show in a popup. Perhaps you could attach a screenshot of the feature in the "popular IDE" that might demonstrate the desired effect.

You might also be interested in a new feature in the upcoming gopls/v0.16.0 release: an integrated viewer for Go package documentation; see https://cs.opensource.google/go/x/tools/+/master:gopls/doc/release/v0.16.0.md.

Just looked at the Integrated documentation viewer, that very cool. So, regarding the implementation of this feature in the "known IDE", it looks like this.;

The method names are actually url (obvious when you hover, shows the underline), when you click them...

The full type popup tears down then this 👆, to get back, you just press the type name in the receiver. Very neat, but this would require HTML, which is sanitized in vscode-go extension (I actually discovered so, I have not looked at the extension code, I actually did... did'nt figure much of it).

My plan was to use the details tag of markdown, but it still html, sanitized too. It looks like this;

func (b *Builder) copyCheck()

I don't know why it showing the copy thing... guessing Github, like I mentioned, I could not test this out, since the html was sanitized.

Re-opening so we can discuss this in our triage meeting.

Re-opening so we can discuss this in our triage meeting.

Oh...this is good, I did see the word "triage" in the contribution guide ( I did'nt keep in my head, I'll look it up again), I had another thought about implementing what the "popular IDE" has.

As the LSP specs dictates, the return from Hover can be a MarkString, []MarkString or MarkUpContent, MarkString is deprecated though. If we can an array of MarkString or MarkUpContent, the other items would be the docs, so the 0th item would be the popup has we have it before, each method having a url that point to ith item for it docs. The solution would involve touching both the lsp and each editor client.

I just want to mention this too.

I think we're very limited in what we can do in a hover popup, and the current content was chosen to be as dense as possible while retaining readability. A documentation viewer (forthcoming in gopls@v0.16.0) is a better place to view documentation.