Skip to content

Commit

Permalink
fix: Correct documentation for variationDetail for client SDKs. (#509)
Browse files Browse the repository at this point in the history
  • Loading branch information
kinyoklion authored Jul 12, 2024
1 parent 9eac9db commit 496e39f
Showing 1 changed file with 1 addition and 2 deletions.
3 changes: 1 addition & 2 deletions packages/shared/sdk-client/src/api/LDClient.ts
Original file line number Diff line number Diff line change
Expand Up @@ -321,8 +321,7 @@ export interface LDClient {
* Determines the variation of a feature flag for a context, along with information about how it was
* calculated.
*
* Note that this will only work if you have set `evaluationExplanations` to true in {@link LDOptions}.
* Otherwise, the `reason` property of the result will be null.
* Note that this will only work if you have set `withReasons` to true in {@link LDOptions}.
*
* The `reason` property of the result will also be included in analytics events, if you are
* capturing detailed event data for this flag.
Expand Down

0 comments on commit 496e39f

Please sign in to comment.