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/pkgsite: missing documentation headings/anchors #39529

Closed
ribasushi opened this issue Jun 11, 2020 · 2 comments
Closed

x/pkgsite: missing documentation headings/anchors #39529

ribasushi opened this issue Jun 11, 2020 · 2 comments

Comments

@ribasushi
Copy link

@ribasushi ribasushi commented Jun 11, 2020

What is the URL of the page with the issue?

https://pkg.go.dev/github.com/mna/pigeon

What is your user agent?

N/A

Screenshot

N/A

What did you do?

N/A

What did you expect to see?

I was expecting PEG syntax to appear in the TOC on top, and to be linkable (with the ¶ appearing on hover). At present there is no way to replicate https://godoc.org/github.com/mna/pigeon#hdr-PEG_syntax via https://pkg.go.dev

What did you see instead?

See above

@gopherbot gopherbot added the pkgsite label Jun 11, 2020
@gopherbot gopherbot added this to the Unreleased milestone Jun 11, 2020
@julieqiu julieqiu added NeedsFix and removed Documentation labels Jun 15, 2020
@julieqiu julieqiu changed the title go.dev: Missing documentation headings/anchors go.dev: missing documentation headings/anchors Jun 15, 2020
@mvdan
Copy link
Member

@mvdan mvdan commented Jun 15, 2020

Hm, I do see the ¶ link when hovering the heading:

2020-06-15-16:46:57

It takes me to https://pkg.go.dev/github.com/mna/pigeon?tab=doc#hdr-PEG_syntax, which looks correct.

But I can't find the heading in any index section, which I agree is unfortunate.

@julieqiu julieqiu added help wanted and removed Documentation labels Jun 15, 2020
@julieqiu julieqiu changed the title go.dev: missing documentation headings/anchors x/pkgsite: missing documentation headings/anchors Jun 15, 2020
@julieqiu
Copy link
Contributor

@julieqiu julieqiu commented Jun 15, 2020

Thanks for reporting @ribasushi, and for looking into this @mvdan! It does look like the anchor link for https://pkg.go.dev/github.com/mna/pigeon?tab=doc#hdr-PEG_syntax is working as intended, so going to close this issue.

For listing in the index section, this should be fixed by #38073.

@julieqiu julieqiu closed this Jun 15, 2020
@julieqiu julieqiu removed the help wanted label Jun 15, 2020
@julieqiu julieqiu modified the milestones: Unreleased, pkgsite/dochtml Aug 19, 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