go/doc,x/pkgsite: [Context.Err] not linked in rendered doc comments

[mitar]

Variables section has invalid links:

See [Context.Err].

[bcmills]

Possibly related to #61394?

[Goclipse27]

@mitar @bcmills - thanks for linking package zip and struct field link in doc. Here Context.Err - method is in interface and any struct that implements it call the method. Is there in any other package docs, has such link? Shall I help on this issue?

[seankhliao]

see also #39963

[hyangah]

I observed the similar in gopls's hover message.

[Goclipse27]

Thanks @seankhliao.

If we see - https://pkg.go.dev/golang.org/x/mod@v0.12.0/zip#CheckDir - CheckedFiles.Err) is referred as a link in the doc. As Err is a method for CheckedFiles struct and its reference works. Where as [CheckedFiles.SizeError] is a field int struct, it's reference is not working and it has been discussed in #39963 (comment). Looks like @bcmills trying a fix for fields in struct - https://go-review.googlesource.com/c/go/+/510315/6/src/go/doc/doc.go.

Here the situation is for interface methods. As we go with standards - https://go.dev/doc/comment#doclinks. We can try refer only the interface followed by method [context.Context].Err as interface doclinks work - (Example (https://cs.opensource.google/go/go/+/go1.21.3:src/bufio/bufio.go;l=215 , then this Read method can do so as well; see the [io.Reader] docs.)

Any suggestions/feedback are appreciated.

[Goclipse27]

@mitar @bcmills @dr2chase @hyangah - I am able to reproduce the issue locally. And I tried linking interface followed Err() and docs link work too. Please find the screenshot attached. Let me know your feedback.

[Goclipse27]

@mitar @hyangah Please do review if the fix looks ok - https://go-review.googlesource.com/c/go/+/540175

[gopherbot]

Change https://go.dev/cl/540175 mentions this issue: go/doc,x/pkgsite: [Context.Err] not linked in rendered doc comments #63679

[AlexanderYastrebov]

Looks like a duplicate of #62293 which also proposes a fix for this.