Skip to content

Commit 82f1bb2

Browse files
[sc-213100] Clarify that "goals" are the same as "metrics" (#288)
We got feedback from a customer that they were confused by the "goals" language in our SDK docs, which we now call "metrics." This clarifies that goals = metrics and A/B testing = Experimentation. Story details: https://app.shortcut.com/launchdarkly/story/213100
2 parents db998fc + 8e1592c commit 82f1bb2

File tree

2 files changed

+8
-8
lines changed

2 files changed

+8
-8
lines changed

example/index.html

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -228,7 +228,7 @@ <h4>
228228
<div class="card">
229229
<div class="card-body">
230230
<p>
231-
These actions are for testing LaunchDarkly's analytics events and A/B testing features.
231+
These actions are for testing LaunchDarkly's analytics events and Experimentation features.
232232
</p>
233233
<form class="form-inline mb-2">
234234
<button id="pushUrlButton" class="btn btn-secondary btn-sm mr-2" type="button">

typings.d.ts

Lines changed: 7 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -65,10 +65,10 @@ declare module 'launchdarkly-js-client-sdk' {
6565
hash?: string;
6666

6767
/**
68-
* Whether the client should make a request to LaunchDarkly for A/B testing goals.
68+
* Whether the client should make a request to LaunchDarkly for Experimentation metrics (goals).
6969
*
7070
* This is true by default, meaning that this request will be made on every page load.
71-
* Set it to false if you are not using A/B testing and want to skip the request.
71+
* Set it to false if you are not using Experimentation and want to skip the request.
7272
*/
7373
fetchGoals?: boolean;
7474

@@ -99,15 +99,15 @@ declare module 'launchdarkly-js-client-sdk' {
9999
*/
100100
export interface LDClient extends LDClientBase {
101101
/**
102-
* Allows you to wait until the client has received goals data from LaunchDarkly.
102+
* Allows you to wait until the client has received metrics (goals) data from LaunchDarkly.
103103
*
104-
* This is only relevant if you are using A/B testing features like click events and
105-
* pageview events; until the client has received the configuration for these (which
106-
* happens immediately after the initial request for feature flags), click events and
104+
* This is only relevant if you are using Experimentation features like click events and
105+
* pageview events. Until the client has received the configuration for these, which
106+
* happens immediately after the initial request for feature flags, click events and
107107
* pageview events will not work, so you may wish to wait using this method before
108108
* doing anything that you expect to generate those events.
109109
*
110-
* The returned Promise will be resolved once the client has received goals data. If
110+
* The returned Promise will be resolved once the client has received metrics data. If
111111
* you prefer to use event handlers rather than Promises, you can listen on the client
112112
* for a `"goalsReady"` event instead.
113113
*

0 commit comments

Comments
 (0)