x/tools/gopls: add method documentation & jump to page source to hovered type.

[tobyweb3x]

gopls version

Build info ---------- golang.org/x/tools/gopls v0.15.2 golang.org/x/tools/gopls@v0.15.2 h1:4JKt4inO8JaFW3l/Fh9X1k/5JQn+iUOpdc4/Lpi0mOs= github.com/BurntSushi/toml@v1.2.1 h1:9F2/+DoOYIOksmaJFPw1tGFy1eDnIJXg+UHjuD8lTak= github.com/google/go-cmp@v0.6.0 h1:ofyhxvXcZhMsU5ulbFiLKl/XBFqE1GSq7atu8tAmTRI= golang.org/x/exp/typeparams@v0.0.0-20221212164502-fae10dda9338 h1:2O2DON6y3XMJiQRAS1UWU+54aec2uopH3x7MAiqGW6Y= golang.org/x/mod@v0.15.0 h1:SernR4v+D55NyBH2QiEQrlBAnj1ECL6AGrA5+dPaMY8= golang.org/x/sync@v0.6.0 h1:5BMeUDZ7vkXGfEr1x9B4bRcTH4lpkTkpdh0T/J+qjbQ= golang.org/x/telemetry@v0.0.0-20240209200032-7b892fcb8a78 h1:vcVnuftN4J4UKLRcgetjzfU9FjjgXUUYUc3JhFplgV4= golang.org/x/text@v0.14.0 h1:ScX5w1eTa3QqT8oi6+ziP7dTV1S2+ALU0bI+0zXKWiQ= golang.org/x/tools@v0.18.1-0.20240311201521-78fbdeb61842 h1:No0LMXYFkp3j4oEsPdtY8LUQz33gu79Rm9DE+izMeGQ= golang.org/x/vuln@v1.0.1 h1:KUas02EjQK5LTuIx1OylBQdKKZ9jeugs+HiqO5HormU= honnef.co/go/tools@v0.4.6 h1:oFEHCKeID7to/3autwsWfnuv69j3NsfcXbvJKuIcep8= mvdan.cc/gofumpt@v0.6.0 h1:G3QvahNDmpD+Aek/bNOLrFR2XC6ZAdo62dZu65gmwGo= mvdan.cc/xurls/v2@v2.5.0 h1:lyBNOm8Wo71UknhUs4QTFUNNMyxy2JEIaKKo0RWOh+8= go: go1.22.1

go env

GO111MODULE=''
GOARCH='amd64'
GOBIN=''
GOCACHE='/home/tobigiwa/.cache/go-build'
GOENV='/home/tobigiwa/.config/go/env'
GOEXE=''
GOEXPERIMENT=''
GOFLAGS=''
GOHOSTARCH='amd64'
GOHOSTOS='linux'
GOINSECURE=''
GOMODCACHE='/home/tobigiwa/go/pkg/mod'
GONOPROXY=''
GONOSUMDB=''
GOOS='linux'
GOPATH='/home/tobigiwa/go'
GOPRIVATE=''
GOPROXY='https://proxy.golang.org,direct'
GOROOT='/usr/local/go'
GOSUMDB='sum.golang.org'
GOTMPDIR=''
GOTOOLCHAIN='auto'
GOTOOLDIR='/usr/local/go/pkg/tool/linux_amd64'
GOVCS=''
GOVERSION='go1.22.1'
GCCGO='gccgo'
GOAMD64='v1'
AR='ar'
CC='gcc'
CXX='g++'
CGO_ENABLED='1'
GOMOD='/home/tobigiwa/mod/tools/gopls/go.mod'
GOWORK=''
CGO_CFLAGS='-O2 -g'
CGO_CPPFLAGS=''
CGO_CXXFLAGS='-O2 -g'
CGO_FFLAGS='-O2 -g'
CGO_LDFLAGS='-O2 -g'
PKG_CONFIG='pkg-config'
GOGCCFLAGS='-fPIC -m64 -pthread -Wl,--no-gc-sections -fmessage-length=0 -ffile-prefix-map=/tmp/go-build2583342046=/tmp/go-build -gno-record-gcc-switches'

What did you do?

No error, just feature request.

What did you see happen?

Hover on user defined type, or any type with method just shows method signature only. Most of the time, I'll like to know what these method do and be able to jump into them easily.

What did you expect to see?

Method docs and jump to page source in hover popup.

Editor and settings

Nothing extra.

Logs

No response

[gopherbot]

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

[tobyweb3x]

from

[tobyweb3x]

To

[gopherbot]

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

[adonovan]

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.

[adonovan]

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.

[tobyweb3x]

@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.