fix: Correct documentation for variationDetail for client SDKs. (#509)

kinyoklion · web-flow · commit 496e39f54a44 · 2024-07-12T13:10:49.000-07:00
diff --git a/packages/shared/sdk-client/src/api/LDClient.ts b/packages/shared/sdk-client/src/api/LDClient.ts
@@ -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.

Original file line number	Diff line number	Diff line change
`@@ -321,8 +321,7 @@ export interface LDClient {`
`321`	`321`	`* Determines the variation of a feature flag for a context, along with information about how it was`
`322`	`322`	`* calculated.`
`323`	`323`	`*`
`324`		- * Note that this will only work if you have set `evaluationExplanations` to true in {@link LDOptions}.
`325`		- * Otherwise, the `reason` property of the result will be null.
	`324`	+ * Note that this will only work if you have set `withReasons` to true in {@link LDOptions}.
`326`	`325`	`*`
`327`	`326`	* The `reason` property of the result will also be included in analytics events, if you are
`328`	`327`	`* capturing detailed event data for this flag.`