Skip to content
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/cmd/godoc: global variable example is not rendered #19372

Closed
rakyll opened this issue Mar 2, 2017 · 2 comments

Comments

Projects
None yet
3 participants
@rakyll
Copy link
Member

commented Mar 2, 2017

x/oauth2 package wants to attach an example to a global variable, see golang/oauth2@efb10a3.

godoc fails to render the example under HTTPClient even though it lists the example in the table of contents.

See the screenshot:

screenshot

@agnivade

This comment has been minimized.

Copy link
Member

commented Jan 22, 2018

@rakyll - Looks like you fixed it with this commit golang/oauth2@d89af98. I think the example names have to match either a top-level function or a type, which is why ExampleCustomHTTP wasn't getting rendered, but ExampleConfig_customHTTP did.

Should this be closed then ?

@rakyll

This comment has been minimized.

Copy link
Member Author

commented Jan 22, 2018

@agnivade, this issue looks obsolete now. I am closing it.

@rakyll rakyll closed this Jan 22, 2018

@golang golang locked and limited conversation to collaborators Jan 22, 2019

Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
You can’t perform that action at this time.