fix documentation for trace.Status (open-telemetry#2029)

0xc0d · web-flow · commit 311a6396a7a4 · 2021-06-24T12:41:08.000-07:00
diff --git a/sdk/trace/span.go b/sdk/trace/span.go
@@ -635,7 +635,7 @@ func isSampled(s SamplingResult) bool {
 type Status struct {
 	// Code is an identifier of a Spans state classification.
 	Code codes.Code
-	// Message is a user hint about why that status was set. It is only
+	// Description is a user hint about why that status was set. It is only
 	// applicable when Code is Error.
 	Description string
 }

Original file line number	Diff line number	Diff line change
`@@ -635,7 +635,7 @@ func isSampled(s SamplingResult) bool {`
`635`	`635`	`type Status struct {`
`636`	`636`	`// Code is an identifier of a Spans state classification.`
`637`	`637`	`Code codes.Code`
`638`		`- // Message is a user hint about why that status was set. It is only`
	`638`	`+ // Description is a user hint about why that status was set. It is only`
`639`	`639`	`// applicable when Code is Error.`
`640`	`640`	`Description string`
`641`	`641`	`}`