Fix confusion in the SpanFilter docstring (#3851)

sulami · web-flow · commit 3da4cfd99281 · 2024-08-21T12:16:42.000-04:00
The docstring was claiming that a truthy value from the filter block
keeps the span, but in fact it's the other way around, a truthy value
drops the span.
diff --git a/lib/datadog/tracing/pipeline/span_filter.rb b/lib/datadog/tracing/pipeline/span_filter.rb
@@ -10,8 +10,8 @@ module Pipeline
       # This processor executes the configured `operation` for each {Datadog::Tracing::Span}
       # in a {Datadog::Tracing::TraceSegment}.
       #
-      # If `operation` returns a truthy value for a span, that span is kept,
-      # otherwise the span is removed from the trace.
+      # If `operation` returns a truthy value for a span, that span is dropped,
+      # otherwise the span is kept.
       #
       # @public_api
       class SpanFilter < SpanProcessor

Original file line number	Diff line number	Diff line change
`@@ -10,8 +10,8 @@ module Pipeline`
`10`	`10`	# This processor executes the configured `operation` for each {Datadog::Tracing::Span}
`11`	`11`	`# in a {Datadog::Tracing::TraceSegment}.`
`12`	`12`	`#`
`13`		- # If `operation` returns a truthy value for a span, that span is kept,
`14`		`- # otherwise the span is removed from the trace.`
	`13`	+ # If `operation` returns a truthy value for a span, that span is dropped,
	`14`	`+ # otherwise the span is kept.`
`15`	`15`	`#`
`16`	`16`	`# @public_api`
`17`	`17`	`class SpanFilter < SpanProcessor`