Open ChrisHines opened 6 years ago
It looks like GoDoc replaces any instances of the text package <name>
with a link to that package, which explains why you're seeing just a link to the log
package.
Without changing any of the functionality of GoDoc, the easiest thing to do is rephrase the comment;
// Package level implements leveled logging on top of the log package.
Here's the lines of interest; https://github.com/golang/gddo/blob/574849d519ec3acb591fc5620ee0aa3ea48081e0/gddo-server/template.go#L391-L404
Where packagePat
is this;
https://github.com/golang/gddo/blob/574849d519ec3acb591fc5620ee0aa3ea48081e0/gddo-server/template.go#L341
Thanks for doing the research to figure that out. Rephrasing the comment is doable.
/cc @dsnet FYI. This issue is something to be aware of when trying to linkify identifiers within the docs.
It also looks like it does something similar for RFCs (and converting h3s to h4s, but that's not as interesting);
The first sentence of the package docs for github.com/go-kit/kit/log/level reads:
Godoc.org magically makes the word "log" into a link to the standard library log package, when in fact it is referring to the package github.com/go-kit/kit/log.