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.

Sign up for GitHub

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

Jump to bottom

go/doc: Package.Parser should collect up interface methods #62293

Open
dsnet opened this issue Aug 25, 2023 · 1 comment
Open

go/doc: Package.Parser should collect up interface methods #62293

dsnet opened this issue Aug 25, 2023 · 1 comment
Labels
Documentation NeedsDecision Feedback is required from experts, contributors, and/or the community before a change can be made.

Comments

@dsnet
Copy link
Member

dsnet commented Aug 25, 2023

Currently, the methods of a interface are not linkable because Package.Parser does not collect them up.

Thus, if you put a declaration like [Reader.Read] within the io package, the pkgsite is not able to link to the Read method.

It is unclear how to best fix this. Ideally interface methods appear in Type.Methods, but historically they have not.
Adding them in there could break tools that are not expecting their appearance.
@gopherbot
Copy link

Change https://go.dev/cl/523059 mentions this issue: internal/godoc/dochtml/internal/render: fix linking of interface methods

@joedian joedian added Documentation NeedsDecision Feedback is required from experts, contributors, and/or the community before a change can be made. labels Aug 28, 2023
@dsnet dsnet mentioned this issue Oct 12, 2023
Closed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees
No one assigned
Labels
Documentation NeedsDecision Feedback is required from experts, contributors, and/or the community before a change can be made.
Projects
None yet
Milestone
No milestone
Development

No branches or pull requests
3 participants
@dsnet @gopherbot @joedian