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: documentation misparsed as an anchor #39270

Closed
dottedmag opened this issue May 27, 2020 · 3 comments
Closed

x/pkgsite: documentation misparsed as an anchor #39270

dottedmag opened this issue May 27, 2020 · 3 comments

Comments

@dottedmag
Copy link
Contributor

@dottedmag dottedmag commented May 27, 2020

What is the URL of the page with the issue?

https://pkg.go.dev/github.com/ridge/must@v0.2.0?tab=doc#Do

What is your user agent?

Vivaldi 81.0.4044.142

Screenshot

Screenshot 2020-05-27 at 13 47 39

What did you do?

Nothing

What did you expect to see?

"Do calls the function and panics on error" is not an anchor.

What did you see instead?

"Do calls the function and panics on error" is an anchor.

godoc.org handles it properly: https://godoc.org/github.com/ridge/must#Do

@gopherbot gopherbot added the pkgsite label May 27, 2020
@gopherbot gopherbot added this to the Unreleased milestone May 27, 2020
@julieqiu julieqiu added NeedsFix and removed Documentation labels May 27, 2020
@julieqiu
Copy link
Contributor

@julieqiu julieqiu commented May 27, 2020

Thanks for reporting the bug! We'll work on a fix.

@julieqiu julieqiu changed the title go.dev: Misparses documentation as an anchor go.dev: misparses documentation as an anchor May 27, 2020
@julieqiu julieqiu changed the title go.dev: misparses documentation as an anchor go.dev: documentation misparsed as an anchor May 27, 2020
@julieqiu julieqiu changed the title go.dev: documentation misparsed as an anchor x/pkgsite: documentation misparsed as an anchor Jun 15, 2020
@julieqiu julieqiu added the Suggested label Jun 15, 2020
@kisunji
Copy link

@kisunji kisunji commented Jun 16, 2020

According to this comment, this is expected behaviour (albeit one which maybe didn't exist in godoc)

This line does not end in a punctuation:
https://github.com/ridge/must/blob/v0.2.0/must.go#L42

Is this something to be fixed?

@dottedmag
Copy link
Contributor Author

@dottedmag dottedmag commented Jun 16, 2020

No, it's fine.

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