Skip to content

/go

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/godoc: unreadable index headers #32532

Open
dsnet opened this issue Jun 10, 2019 · 0 comments

Comments

@dsnet
Copy link
Member

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 referenced 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 label Jun 10, 2019

@dmitshur dmitshur self-assigned this Jun 10, 2019

@dmitshur dmitshur added NeedsFix and removed NeedsInvestigation labels Jun 28, 2019

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees

@dmitshur dmitshur

Labels
NeedsFix
Projects
None yet
Milestone
  Unreleased
3 participants
@dsnet @dmitshur @gopherbot
You can’t perform that action at this time.