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/cmd/godoc: turn URL in struct comments to links #12479

Open
dsnet opened this Issue Sep 3, 2015 · 3 comments

Comments

Projects
None yet
4 participants
@dsnet
Member

dsnet commented Sep 3, 2015

This is already done for function comments, but it would be nice if URLs in struct, interface, and slice comments were turned into links as well.

See crypto/tls.ClientHelloInfo.

@bradfitz

This comment has been minimized.

Member

bradfitz commented Sep 3, 2015

/cc @adg

@rsc

This comment has been minimized.

Contributor

rsc commented Oct 23, 2015

Comments inside struct { } and interface { } definitions and inside struct, interface, and slice literals are not doc comments. Godoc only reformats doc comments.

There is a long-standing issue that we should probably do better in general with comments inside top-level struct { } and interface { } definitions, since those are effectively the doc comments for individual fields.

Whether godoc should apply hyperlinking to arbitrary non-doc comments (such as inside slice literals) is much less clear.

@rsc rsc added this to the Unplanned milestone Oct 23, 2015

@gopherbot

This comment has been minimized.

gopherbot commented Oct 24, 2017

Change https://golang.org/cl/72890 mentions this issue: godoc/internal/render: add render package for text formatting

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