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

gopls: added method docs to hover info #487

Open
wants to merge 1 commit into
base: master
Choose a base branch
from

Conversation

tobigiwa
Copy link

@tobigiwa tobigiwa commented Apr 8, 2024

The change also includes a jump to definition feature for all methods.The change is quite fail-safe, such that if it fails in any way, it will still display the hover info without the method docs(as before). The change is localised to the the gopls/internal/golang/hover.go file, in function hover and formatHover.
I should also mention that it does not alter the method displayed or it order, it just add the method docs (if any) and a jump to page source url to the hover info.

Fixes golang/go#66721
Fixes golang/go#66721

The change also includes a jump to definition feature for all methods.The
change is quite fail-safe, such that if it fails in any way, it will still
display the hover info without the method docs(as before). The change is
localised to the the gopls/internal/golang/hover.go file, in function
hover and formatHover.
I should also mention that it does not alter the method displayed or it
order, it just add the method docs (if any) and a jump to page source
url to the hover info.

Fixes golang/go#66721
Fixes golang/go#66721

Signed-off-by: tobigiwa <[email protected]>
@gopherbot
Copy link
Contributor

This PR (HEAD: 27d26b0) has been imported to Gerrit for code review.

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

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
Contributor

Message from Gopher Robot:

Patch Set 1:

(1 comment)


Please don’t reply on this GitHub thread. Visit golang.org/cl/577356.
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: add method documentation & jump to page source to hovered type.
2 participants