You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
godoc's generated HTML includes lots of handy anchor tags for every element of the documentation. If you wish to look up a tag in order to link to a particular section, it's not always easy to get at the tag.
For types, functions, and methods, you can scroll up and find the corresponding index entry and click on that. For subsections of the overview section (e.g. https://golang.org/pkg/text/template/#hdr-Arguments), the link doesn't appear anywhere on the page that I can see. (I usually right click > Inspect in Chrome.)
To make these easier, it would be nice if go/doc's HTML output included a small link beside every anchored element. For one example of how this might look, Github renders markdown with a little anchor link beside each section that only appears on hover. (See https://github.com/golang/go#binary-distribution-notes and hover over "Binary Distribution Notes".)
Another, smaller change that would help is if subsections of the Overview were listed in the index at the very top of the page.
The text was updated successfully, but these errors were encountered:
rsc
changed the title
go/doc: make it easier to get anchor links
cmd/godoc: make it easier to get anchor links
Dec 28, 2015
Added anchor link beside each function, type and method definition in
godoc's generated HTML. Anchor links are only shown when the mouse is
hovering over the definition. The link body is the Unicode PILCROW SIGN
character (¶ HTML entity).
Fixes: golang/go#13748
Change-Id: I645269f6c229f76b2882899e1a7483577877ac30
Reviewed-on: https://go-review.googlesource.com/20246
Reviewed-by: Andrew Gerrand <adg@golang.org>
Sign up for freeto subscribe to this conversation on GitHub.
Already have an account?
Sign in.
godoc's generated HTML includes lots of handy anchor tags for every element of the documentation. If you wish to look up a tag in order to link to a particular section, it's not always easy to get at the tag.
For types, functions, and methods, you can scroll up and find the corresponding index entry and click on that. For subsections of the overview section (e.g. https://golang.org/pkg/text/template/#hdr-Arguments), the link doesn't appear anywhere on the page that I can see. (I usually right click > Inspect in Chrome.)
To make these easier, it would be nice if go/doc's HTML output included a small link beside every anchored element. For one example of how this might look, Github renders markdown with a little anchor link beside each section that only appears on hover. (See https://github.com/golang/go#binary-distribution-notes and hover over "Binary Distribution Notes".)
Another, smaller change that would help is if subsections of the Overview were listed in the index at the very top of the page.
The text was updated successfully, but these errors were encountered: