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: HTML formatting doesn't make association between comments and code clear #16728

Closed
mkrautz opened this issue Aug 16, 2016 · 5 comments

Comments

Projects
None yet
5 participants
@mkrautz
Copy link
Contributor

commented Aug 16, 2016

screen shot 2016-08-16 at 10 51 42

@mkrautz

This comment has been minimized.

Copy link
Contributor Author

commented Aug 16, 2016

Hmm. I now see that that's just the way godoc does things.

I was just confused by the paragraph in the context of the "Variables" section.

It's not clear whether it documents what's above it (the errors), or the new context variables below it. Perhaps because neither the first errors section nor the new context section has a comment attached to them.

@bradfitz bradfitz changed the title net/http: Go 1.7 docs for net/http has out-of-place "Errors used by the HTTP server" paragraph x/tools/cmd/godoc: HTML formatting doesn't make association between comments and code clear Aug 16, 2016

@bradfitz bradfitz added this to the Go1.8Maybe milestone Aug 16, 2016

@bradfitz

This comment has been minimized.

Copy link
Member

commented Aug 16, 2016

/cc @broady

@gopherbot

This comment has been minimized.

Copy link

commented Oct 27, 2016

CL https://golang.org/cl/32153 mentions this issue.

@gopherbot

This comment has been minimized.

Copy link

commented Oct 27, 2016

CL https://golang.org/cl/32154 mentions this issue.

@gopherbot

This comment has been minimized.

Copy link

commented Nov 17, 2016

CL https://golang.org/cl/33279 mentions this issue.

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.