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

Jump to bottom

x/tools/godoc: index headers don't shorten verbose inline type definitions #32532

Open
dsnet opened this issue Jun 10, 2019 · 1 comment
Open

x/tools/godoc: index headers don't shorten verbose inline type definitions #32532

dsnet opened this issue Jun 10, 2019 · 1 comment
Labels
NeedsFix The path to resolution is known, but the work has not been done.
Milestone
Unreleased

Comments

@dsnet
Copy link
Member

dsnet commented Jun 10, 2019 •
edited

(moved from google/go-cmp#135)

When a declaration includes anonymous types, the index can format the declaration as something completely unreadable. For example, see the Reporter type in the index list of cmp.

Note that affects gddo and x/tools/godoc, but not cmd/go/doc since I fixed this in 2016. The fundamental problem is that all the godoc-like tools do not share much logic in terms of how it renders the front-end, so improvements to one are not benefited by all.
@gopherbot gopherbot added this to the Unreleased milestone Jun 10, 2019
@dsnet dsnet mentioned this issue Jun 10, 2019
Closed
@dsnet dsnet changed the title x/tools/godoc: readable index headers x/tools/godoc: unreadable index headers Jun 10, 2019
@dmitshur dmitshur added the NeedsInvestigation Someone must examine and confirm this is a valid issue and not a duplicate of an existing one. label Jun 10, 2019
@dmitshur dmitshur self-assigned this Jun 10, 2019
@dmitshur dmitshur added NeedsFix The path to resolution is known, but the work has not been done. and removed NeedsInvestigation Someone must examine and confirm this is a valid issue and not a duplicate of an existing one. labels Jun 28, 2019
@dmitshur dmitshur changed the title x/tools/godoc: unreadable index headers x/tools/godoc: index headers don't shorten verbose inline type definitions Sep 18, 2019
This was referenced Oct 8, 2019
Closed
Closed
@dmitshur
Copy link
Contributor

dmitshur commented Nov 5, 2019 •
edited

This is already fixed in the documentation rendering done by discovery site (tracked in issue #33654):

What remains here is to backport the fix to x/tools/cmd/godoc.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees
No one assigned
Labels
NeedsFix The path to resolution is known, but the work has not been done.
Projects
None yet
Milestone
Unreleased
Development

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