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

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

x/tools/cmd/godoc: turn URL in struct comments to links #12479

dsnet opened this issue Sep 3, 2015 · 3 comments
Labels
NeedsInvestigation Someone must examine and confirm this is a valid issue and not a duplicate of an existing one. Tools This label describes issues relating to any tools in the x/tools repository.
Milestone
Unplanned

Comments

@dsnet
Copy link
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
Copy link
Contributor

bradfitz commented Sep 3, 2015

/cc @adg

@rsc
Copy link
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
Copy link

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

@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 26, 2019
@gopherbot gopherbot added the Tools This label describes issues relating to any tools in the x/tools repository. label Sep 12, 2019
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees
No one assigned
Labels
NeedsInvestigation Someone must examine and confirm this is a valid issue and not a duplicate of an existing one. Tools This label describes issues relating to any tools in the x/tools repository.
Projects
None yet
Milestone
Unplanned
Development

No branches or pull requests
5 participants
@bradfitz @rsc @dmitshur @dsnet @gopherbot