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
I wanted to have identifiers in comments turn into links, for ease of navigation. I have comments like the following in my repos:
// SomeFunction does something.
// SomeFunction can not be called concurrently; you can use OtherFunction
// if your code must be able to perform this operation concurrently.
func SomeFunction() {
// ...
}
// OtherFunction is the same as SomeFunction but it can be called concurrently.
func OtherFunction() {
}
Note that this would not need to apply only to functions. Ideally it should happen for any (public?) identifier in the same package, as well as for public identifiers in other packages (if they are properly prefixed with the package name).
Examples of places where this could be useful (cursory check on a single package in the stdlib):
What version of Go are you using (
go version
)?Does this issue reproduce with the latest release?
Yes
What operating system and processor architecture are you using (
go env
)?go env
OutputWhat did you do?
I wanted to have identifiers in comments turn into links, for ease of navigation. I have comments like the following in my repos:
Note that this would not need to apply only to functions. Ideally it should happen for any (public?) identifier in the same package, as well as for public identifiers in other packages (if they are properly prefixed with the package name).
Examples of places where this could be useful (cursory check on a single package in the stdlib):
What did you expect to see?
I would expect the
SomeOtherFunction
in the comment be rendered as a link to SomeOtherFunction in the HTML output of godoc.What did you see instead?
No links. 😭
The text was updated successfully, but these errors were encountered: