-
Notifications
You must be signed in to change notification settings - Fork 17.7k
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: add support for hotlinks #25444
Comments
Is there any update on this? I seem to recall you did this already and even had it hosted somewhere. |
@dsnet has created a prototype for this, and this proposal is accepted, so it will be integrated into |
I re-filed sections as a proposal again (see #44447). I recently revisited some of my prototype work with hotlinking (#25444) and I'm increasingly convinced that it's troublesome since it can't completely eliminate the presence of false-positives, which is harmful because it actively links users to the wrong information. Furthermore, it goes against the Go philosophy that "clear is better than clever". See the end of the proposal in #44447 for detailed arguments against hotlinking. |
I've been dubious about the hot-linking feature as it currently stands due to it propensity for false positives. I filed #45533 to amend this accepted feature to use an explicit syntax for links. |
I think we can close this with the addition of links in comments. |
Per #18342 (comment), the addition of hotlinks was accepted to be added to godoc. Filing this as a separate issue since the previous issue is conflating sections and hotlinks.
The design for it is in my comment here: #18342 (comment)
The text was updated successfully, but these errors were encountered: