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

go.dev: Examples title is not generated, anchor link to examples is not working #37198

Closed
rakyll opened this issue Feb 12, 2020 · 4 comments
Closed
Assignees
Labels
Milestone

Comments

@rakyll
Copy link
Member

@rakyll rakyll commented Feb 12, 2020

On https://pkg.go.dev/cloud.google.com/go, the "Examples" anchor link is not working because there is no "Examples" title in the page. I couldn't reproduce it in other pages.

@gopherbot gopherbot added this to the Unreleased milestone Feb 12, 2020
@gopherbot gopherbot added the go.dev label Feb 12, 2020
@julieqiu

This comment has been minimized.

Copy link

@julieqiu julieqiu commented Feb 12, 2020

/cc @dmitshur

@dmitshur

This comment has been minimized.

Copy link
Member

@dmitshur dmitshur commented Feb 12, 2020

Thanks for reporting.

@dmitshur dmitshur self-assigned this Feb 12, 2020
@dmitshur

This comment has been minimized.

Copy link
Member

@dmitshur dmitshur commented Feb 12, 2020

There was an issue in the template for the edge case when a package has examples, but no exported identifiers.

The fix is to display the "Index" section (which includes the "Examples" subsection) in that case, so that the link on top is valid. This is consistent with x/tools/cmd/godoc and gddo. I've sent a fix CL.

Edit: The fix CL has been submitted, so this should be fixed next time pkg.go.dev is deployed and the documentation for the affected package(s) is updated.

@dmitshur

This comment has been minimized.

Copy link
Member

@dmitshur dmitshur commented Feb 26, 2020

This issue is resolved at https://pkg.go.dev/cloud.google.com/go by now, so I'll close this. Please let me know if there's anything more.

@dmitshur dmitshur closed this Feb 26, 2020
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Linked pull requests

Successfully merging a pull request may close this issue.

None yet
4 participants
You can’t perform that action at this time.