Skip to content

gopls/hover: show named func type doc when hovering over func literal#634

Open
abhay1999 wants to merge 1 commit intogolang:masterfrom
abhay1999:gopls-hover-funclittype-clean
Open

gopls/hover: show named func type doc when hovering over func literal#634
abhay1999 wants to merge 1 commit intogolang:masterfrom
abhay1999:gopls-hover-funclittype-clean

Conversation

@abhay1999
Copy link
Copy Markdown
Contributor

@abhay1999 abhay1999 commented Apr 8, 2026

When a func literal is implicitly converted to a named function type
(e.g. fs.WalkDirFunc), hovering over its "func" keyword now shows the
documentation and signature of that named type, with a link to
pkg.go.dev.

Previously, hovering over "func" in:

filepath.WalkDir(dir, func(path string, d fs.DirEntry, err error) error {
	...
})

showed only the anonymous signature. Now it shows the docs for
fs.WalkDirFunc, which is often the information the user actually wants.

Implementation: when cur.Node() is *ast.FuncType with the cursor at the
"func" token and the parent is a *ast.FuncLit, the new hoverFuncLit
function calls typesutil.TypesFromContext to find the named function
type the literal must satisfy, loads the declaring package via
NarrowestDeclaringPackage, and returns a hoverResult with the named
type's documentation, signature, and pkg.go.dev link. If no named type
is found, it falls back to the existing anonymous-type hover behavior.

Note: FindByPos at a FuncLit's "func" token returns the inner
*ast.FuncType node (not *ast.FuncLit), so the code checks the parent
node to detect the FuncLit context.

A marker test is added in hover/funclittype.txt covering both the
named-type case and the fallback case.

Fixes golang/go#76191

When a func literal is implicitly converted to a named function type
(e.g. fs.WalkDirFunc), hovering over its "func" keyword now shows the
documentation and signature of that named type, with a link to pkg.go.dev.

Previously, hovering over "func" in:

    filepath.WalkDir(dir, func(path string, d fs.DirEntry, err error) error {
        ...
    })

showed only the anonymous signature "func(path string, d fs.DirEntry,
err error) error". Now it shows the docs for fs.WalkDirFunc, which is
often the information the user actually wants.

Implementation:
- Detect the case in the hover switch: when cur.Node() is *ast.FuncType
  and the cursor is at the "func" token and the parent is a *ast.FuncLit.
- Use typesutil.TypesFromContext to find the named function type the
  literal must satisfy.
- Load the declaring package and build a hoverResult with the named
  type's documentation, signature, and pkg.go.dev link.
- If no named type is found, fall back to the existing anonymous-type
  hover behavior.

Add a marker test in hover/funclittype.txt covering both cases.

Fixes golang/go#76191
@gopherbot
Copy link
Copy Markdown
Contributor

This PR (HEAD: 82a1fea) has been imported to Gerrit for code review.

Please visit Gerrit at https://go-review.googlesource.com/c/tools/+/764120.

Important tips:

  • Don't comment on this PR. All discussion takes place in Gerrit.
  • You need a Gmail or other Google account to log in to Gerrit.
  • To change your code in response to feedback:
    • Push a new commit to the branch used by your GitHub PR.
    • A new "patch set" will then appear in Gerrit.
    • Respond to each comment by marking as Done in Gerrit if implemented as suggested. You can alternatively write a reply.
    • Critical: you must click the blue Reply button near the top to publish your Gerrit responses.
    • Multiple commits in the PR will be squashed by GerritBot.
  • The title and description of the GitHub PR are used to construct the final commit message.
    • Edit these as needed via the GitHub web interface (not via Gerrit or git).
    • You should word wrap the PR description at ~76 characters unless you need longer lines (e.g., for tables or URLs).
  • See the Sending a change via GitHub and Reviews sections of the Contribution Guide as well as the FAQ for details.

@gopherbot
Copy link
Copy Markdown
Contributor

Message from Gopher Robot:

Patch Set 1:

(1 comment)


Please don’t reply on this GitHub thread. Visit golang.org/cl/764120.
After addressing review feedback, remember to publish your drafts!

@gopherbot
Copy link
Copy Markdown
Contributor

Message from Abhay Chaurasiya:

Patch Set 1:

(1 comment)


Please don’t reply on this GitHub thread. Visit golang.org/cl/764120.
After addressing review feedback, remember to publish your drafts!

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

x/tools/gopls: Hover: for func literal implicitly converted to named func type, show doc for that type

2 participants