Skip to content

runtime/trace: broken package documentation #26309

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.

Sign up for GitHub

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

Jump to bottom
Closed
ainar-g opened this issue Jul 10, 2018 · 2 comments
Closed

runtime/trace: broken package documentation #26309

ainar-g opened this issue Jul 10, 2018 · 2 comments
Labels
Documentation Issues describing a change to documentation. FrozenDueToAge NeedsFix The path to resolution is known, but the work has not been done.
Milestone
Go1.11

Comments

@ainar-g
Copy link
Contributor

ainar-g commented Jul 10, 2018

What version of Go are you using (go version)?

+c78b769

What did you do?

Go to the package docs or to https://tip.golang.org/pkg/.

What did you expect to see?

trace    Package trace contains facilities for programs to generate trace for Go execution tracer.

What did you see instead?

trace    go func() { trace.WithRegion(ctx, "steamMilk", steamMilk) milk  <- true }() go func() { trace.WithRegion(ctx, "extractCoffee",  extractCoffee) espresso <- true }() go func() { defer task.End() //  When assemble is done, the order is complete.

There are empty lines in the doc comment in src/runtime/trace/trace.go. Lines 85 and 88.
@gopherbot gopherbot added the Documentation Issues describing a change to documentation. label Jul 10, 2018
@gopherbot
Copy link
Contributor

Change https://golang.org/cl/122898 mentions this issue: runtime/trace: comment newlines to restore correct doc summary

@ALTree
Copy link
Member

ALTree commented Jul 10, 2018

Thanks for the report. I've sent a change to restore the doc summary.

@ALTree ALTree added this to the Go1.11 milestone Jul 10, 2018
@ALTree ALTree added the NeedsFix The path to resolution is known, but the work has not been done. label Jul 10, 2018
@golang golang locked and limited conversation to collaborators Jul 10, 2019
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Assignees
No one assigned
Labels
Documentation Issues describing a change to documentation. FrozenDueToAge NeedsFix The path to resolution is known, but the work has not been done.
Projects
None yet
Milestone
Go1.11
Development

No branches or pull requests
3 participants
@ALTree @ainar-g @gopherbot