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/go/packages: document doesn't show the symbol links #69618

Closed
xieyuschen opened this issue Sep 25, 2024 · 3 comments
Closed

x/tools/go/packages: document doesn't show the symbol links #69618

xieyuschen opened this issue Sep 25, 2024 · 3 comments
Labels
Documentation Issues describing a change to documentation. Tools This label describes issues relating to any tools in the x/tools repository.
Milestone

Comments

@xieyuschen
Copy link
Contributor

Currently, pkg.go.dev of go/packages doesn't show the link of symbols(funciton, struct definition) because the comments haven't used the links notation mentioned in Go Doc Comments.

  1. some symbols should have links

image

  1. issues listed in the comment should be rendered as a list

image

Besides, the [.] hasn't been fixed yet mentioned in #61394, could I know the progress about it?

@gopherbot gopherbot added the Tools This label describes issues relating to any tools in the x/tools repository. label Sep 25, 2024
@gopherbot gopherbot added this to the Unreleased milestone Sep 25, 2024
@gopherbot gopherbot added the Documentation Issues describing a change to documentation. label Sep 25, 2024
@gopherbot
Copy link
Contributor

Change https://go.dev/cl/615695 mentions this issue: go/packages: improve go doc by adding links

@Tharanishwaran
Copy link

can i work on this issue

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