chore: Update docs about default span status (#1416)

plantfansam · web-flow · commit 6623a3e41534 · 2023-01-11T16:05:14.000-06:00
chore: Update docs about default span status (#1416) In the SDK, this defaults to unset https://github.com/open-telemetry/opentelemetry-ruby/blob/48eb8367c2eee15cc59d4f83ee137a9b931695fc/sdk/lib/opentelemetry/sdk/trace/span.rb#L19. In spec, it also notes that default is unset: https://github.com/open-telemetry/opentelemetry-specification/blob/main/specification/trace/api.md#set-status. I don't think span status matters in the context of an API span, but this might reduce the chance of confusion.
diff --git a/api/lib/opentelemetry/trace/span.rb b/api/lib/opentelemetry/trace/span.rb
@@ -115,7 +115,7 @@ def record_exception(exception, attributes: nil); end
 
       # Sets the Status to the Span
       #
-      # If used, this will override the default Span status. Default is OK.
+      # If used, this will override the default Span status. Default status is unset.
       #
       # Only the value of the last call will be recorded, and implementations
       # are free to ignore previous calls.

Original file line number	Diff line number	Diff line change
`@@ -115,7 +115,7 @@ def record_exception(exception, attributes: nil); end`
`115`	`115`
`116`	`116`	`# Sets the Status to the Span`
`117`	`117`	`#`
`118`		`- # If used, this will override the default Span status. Default is OK.`
	`118`	`+ # If used, this will override the default Span status. Default status is unset.`
`119`	`119`	`#`
`120`	`120`	`# Only the value of the last call will be recorded, and implementations`
`121`	`121`	`# are free to ignore previous calls.`