Join GitHub today
GitHub is home to over 36 million developers working together to host and review code, manage projects, and build software together.
Sign upx/tools/godoc: unreadable index headers #32532
Comments
gopherbot
added this to the Unreleased milestone
Jun 10, 2019
dsnet
referenced this issue
Jun 10, 2019
Closed
cmp: Reporter's use of anonymous interface argument creates poor display output in godoc #135
dsnet
changed the title
x/tools/godoc: readable index headers
x/tools/godoc: unreadable index headers
Jun 10, 2019
dmitshur
added
the
NeedsInvestigation
label
Jun 10, 2019
dmitshur
self-assigned this
Jun 10, 2019
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
dsnet commentedJun 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
Reportertype in the index list ofcmp.Note that affects
gddoandx/tools/godoc, but notcmd/go/docsince I fixed this in 2016. The fundamental problem is that all thegodoc-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.