Fix confusion in the SpanFilter docstring #3851
Merged
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
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.
Codecov ReportAll modified and coverable lines are covered by tests ✅
Additional details and impacted files@@ Coverage Diff @@
## master #3851 +/- ##
==========================================
+ Coverage 97.83% 97.85% +0.02%
==========================================
Files 1264 1269 +5
Lines 75725 75868 +143
Branches 3729 3736 +7
==========================================
+ Hits 74084 74244 +160
+ Misses 1641 1624 -17 ☔ View full report in Codecov by Sentry. |
p-datadog
approved these changes
Aug 21, 2024
|
Thank you very much for the PR @sulami |
p-datadog
pushed a commit
to p-datadog/dd-trace-rb
that referenced
this pull request
Aug 21, 2024
* master: Fix confusion in the SpanFilter docstring (DataDog#3851) Reset optflags to O0 [NO-TICKET] Fix profiler `inline` helpers not working when optimization disabled Remove obsolete version Remove obsolete `common-environment-3x` anchor and fix presto host from `.env` Explicit hash Fix schema Lint Use `instance_double` Implement telemetry log
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
What does this PR do?
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.
Motivation:
Found this by accident, and given that "truthy to filter" is already unintuitive enough, having the docs lie doesn't exactly help :D
Additional Notes:
Nope.
How to test the change?
Visual review should suffice.