Repository navigation
docs(core): Correct TransactionData::iter docs about unsampled transactions - #1351
Merged
Merged
Conversation
…ctions The iterator checks whether transaction data exists, which happens whenever a client is bound, independently of the sampling decision. Clarify that sampling only controls whether the transaction is sent. Fixes #1350 Co-Authored-By: Daniel SzokeNSTEIN <7881302+szokeasaurusrex@users.noreply.github.com>
…docs Co-Authored-By: Daniel SzokeNSTEIN <7881302+szokeasaurusrex@users.noreply.github.com>
szokeasaurusrex
approved these changes
Oct 13, 2026
This file contains hidden or 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
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.
The doc comment on
TransactionData::itersaid that unsampled transactions have no populated metadata, so the iterator is empty. That's wrong. The iterator checkstransaction.is_some(), andTransaction::newsets that whenever a client is bound, no matter what the sampling decision is.This changes only the doc comment. It now just says that the iterator is empty if no client was bound when the transaction was started.
There's no runtime change.
cargo doc -p sentry-core --no-depsgives the same warning count before and after (all of those warnings already exist and are unrelated).Fixes #1350
via @szokeasaurusrex.
--
View Junior Session [Sentry]