Skip to content

Commit

Permalink
docs: update sampling context parameter description
Browse files Browse the repository at this point in the history
  • Loading branch information
supervacuus authored Jan 15, 2025
1 parent 092de88 commit 8f86933
Showing 1 changed file with 2 additions and 4 deletions.
6 changes: 2 additions & 4 deletions include/sentry.h
Original file line number Diff line number Diff line change
Expand Up @@ -1548,7 +1548,7 @@ typedef double (*sentry_traces_sampler_function)(
/**
* Sets the traces sampler callback. Should be a function that returns a double
* and takes in a sentry_transaction_context_t pointer, a sentry_value_t for
* a custom sampling context and a int pointer for the parent sampled flag.
* a custom sampling context and an int pointer for the parent sampled flag.
*/
SENTRY_EXPERIMENTAL_API void sentry_options_set_traces_sampler(
sentry_options_t *opts, sentry_traces_sampler_function callback);
Expand Down Expand Up @@ -1736,9 +1736,7 @@ SENTRY_EXPERIMENTAL_API void sentry_transaction_context_update_from_header_n(
* constructed by a user.
*
* The second parameter is a custom Sampling Context to be used with a Traces
* Sampler to make a more informed sampling decision. The SDK does not currently
* support a custom Traces Sampler and this parameter is ignored for the time
* being but needs to be provided.
* Sampler to allow you to make a more informed sampling decision.
*
* Returns a Transaction, which is expected to be manually managed by the
* caller. Manual management involves ensuring that `sentry_transaction_finish`
Expand Down

0 comments on commit 8f86933

Please sign in to comment.