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

godoc should format interface types more like other types, displaying methods individually #20326

Closed
cpcallen opened this issue May 11, 2017 · 3 comments

Comments

@cpcallen
Copy link

In e.g. the documentation for the reflect package, concrete types like Value have their methods listed and documented individually, while interface types like Type do not, but force the reader to grovel through the actual source code of interface to find the methods declared on the type. This is a great inconvenience to the reader, particularly because as a consequence the interface type's methods are not listed in the table of contents.

It seems particularly egregious in cases like reflect.Type where the concrete types that fulfil the interface are all unexported, and the user is unlikely to be creating more. The fact that Type is an interface is of no real interest to the reader, and should not affect the format in which the documentation is presented.

@cpcallen cpcallen changed the title godoc should format interface types more like other types, displaying method separately godoc should format interface types more like other types, displaying methods individually May 11, 2017
@jimmyfrasche
Copy link
Member

duplicate of #5860

@cpcallen
Copy link
Author

Drat, didn't see that, despite searching for it. Maybe I was looking only for bugs tagged 'documentation', but I guess it really is a bug against godoc functionality rather than documentation... Sorry!

@ALTree
Copy link
Member

ALTree commented May 11, 2017

Looks like we can close this (we prefer to avoid duplicate issues and this indeed looks like a dup of #5860). Please comment if I'm missing something and this should stay open. Thanks.

@ALTree ALTree closed this as completed May 11, 2017
@golang golang locked and limited conversation to collaborators May 11, 2018
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Projects
None yet
Development

No branches or pull requests

4 participants