From: Charles Kenney <charlesc.kenney@gmail.com>
Date: Mon, 3 Sep 2018 07:02:03 +0000 (+0000)
Subject: [release-branch.go1.11] runtime/trace: fix syntax errors in NewTask doc example
X-Git-Tag: go1.11.1~16
X-Git-Url: http://www.git.cypherpunks.su/?a=commitdiff_plain;h=eeaf877114a2f60dfae7b5c5411ab884ba2a4757;p=gostls13.git

[release-branch.go1.11] runtime/trace: fix syntax errors in NewTask doc example

Fixes #27406

Change-Id: I9c6f5bac5b26558fa7628233c74a62faf676e811
GitHub-Last-Rev: 29d19f719316b486224a15a50556465811985edf
GitHub-Pull-Request: golang/go#27437
Reviewed-on: https://go-review.googlesource.com/132775
Reviewed-by: Emmanuel Odeke <emm.odeke@gmail.com>
Run-TryBot: Emmanuel Odeke <emm.odeke@gmail.com>
TryBot-Result: Gobot Gobot <gobot@golang.org>
(cherry picked from commit b794ca64d29f3e584cbdf49bde7141d3c12dd2ab)
Reviewed-on: https://go-review.googlesource.com/134616
Run-TryBot: Andrew Bonventre <andybons@golang.org>
Reviewed-by: Hyang-Ah Hana Kim <hyangah@gmail.com>
---

diff --git a/src/runtime/trace/annotation.go b/src/runtime/trace/annotation.go
index 3545ef3bba..d5a7d003fe 100644
--- a/src/runtime/trace/annotation.go
+++ b/src/runtime/trace/annotation.go
@@ -24,13 +24,13 @@ type traceContextKey struct{}
 // If the end function is called multiple times, only the first
 // call is used in the latency measurement.
 //
-//   ctx, task := trace.NewTask(ctx, "awesome task")
-//   trace.WithRegion(ctx, prepWork)
+//   ctx, task := trace.NewTask(ctx, "awesomeTask")
+//   trace.WithRegion(ctx, "preparation", prepWork)
 //   // preparation of the task
 //   go func() {  // continue processing the task in a separate goroutine.
 //       defer task.End()
-//       trace.WithRegion(ctx, remainingWork)
-//   }
+//       trace.WithRegion(ctx, "remainingWork", remainingWork)
+//   }()
 func NewTask(pctx context.Context, taskType string) (ctx context.Context, task *Task) {
 	pid := fromContext(pctx).id
 	id := newID()