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/godoc: support linking to interface methods #22892

Open
bradfitz opened this Issue Nov 27, 2017 · 9 comments

Comments

Projects
None yet
6 participants
@bradfitz
Member

bradfitz commented Nov 27, 2017

We can already link to struct fields, as of a few releases ago:

https://golang.org/pkg/net/http/#Server.IdleTimeout

But we can't link to interface methods:

https://golang.org/pkg/net/http/#ResponseWriter.WriteHeader

@bradfitz bradfitz added this to the Go1.11 milestone Nov 27, 2017

@dsnet dsnet self-assigned this Nov 28, 2017

@dsnet

This comment has been minimized.

Member

dsnet commented Nov 28, 2017

My work on #18342 in (CL/72890) actually resolves this issue.

E.g., http.ResponseWriter.WriteHeader

@bradfitz

This comment has been minimized.

Member

bradfitz commented Nov 28, 2017

@dsnet, I haven't been following godoc since I got back. Is that slated for this release?

@dsnet

This comment has been minimized.

Member

dsnet commented Nov 29, 2017

No. It will probably be for Go1.11.

@dsnet dsnet removed the help wanted label Dec 1, 2017

@ugorji

This comment has been minimized.

Contributor

ugorji commented Dec 25, 2017

Any chance we can get this in for go 1.10? It would be really nice to get this in sooner than later. I reckon that this change can go in, as it doesn't affect running programs, but it makes a useful tool much better. Waiting for go 1.11 means waiting until August/Sept 2018 - a very long time away.

@mvdan

This comment has been minimized.

Member

mvdan commented Dec 25, 2017

@ugorji 1.10 is only five weeks away, so this is already the last stage of bugfixing. New features are very unlikely to be merged this late.

It's also worth pointing out that godoc (as part of golang.org/x/...) is not distributed with Go. I'm not sure why the Go1.11 milestone was used, as opposed to the Unreleased one. Perhaps that's related to what will run on godoc.org, as opposed to what will be available via go get.

@ugorji

This comment has been minimized.

Contributor

ugorji commented Dec 25, 2017

@mvdan exactly my point. Since this is not distributed with go, then can we possibly get this in sooner than August/Sept 2018? It feels like we're almost there - and there's no train saying we have to wait for 8/9 months.

@dsnet

This comment has been minimized.

Member

dsnet commented Dec 25, 2017

That is not true. The go, gofmt, and godoc binaries are distributed with each release, effectively pulling in part of the x repo into the release cycle.

@navytux

This comment has been minimized.

Contributor

navytux commented May 18, 2018

And now the story continues of not getting this in into Go 1.11 . Or am I wrong?

@mvdan

This comment has been minimized.

Member

mvdan commented May 18, 2018

For the record, hotlinking is now being tracked at #25444.

@navytux I would suggest getting involved if you would like this to happen faster. For example, I believe that the latest development is this CL, which seems to be looking for more input: https://go-review.googlesource.com/c/tools/+/72890

@ianlancetaylor ianlancetaylor modified the milestones: Go1.11, Go1.12 Jun 29, 2018

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment