Skip to content

chore: clarify that "goals" are the same as "metrics" #244

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 1 commit into from
Aug 23, 2023
Merged

chore: clarify that "goals" are the same as "metrics" #244

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
8 changes: 4 additions & 4 deletions packages/shared/sdk-server/src/api/LDClient.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -177,17 +177,17 @@ export interface LDClient {
/**
* Tracks that a context performed an event.
*
* LaunchDarkly automatically tracks pageviews and clicks that are specified in the Goals section
* of the dashboard. This can be used to track custom goals or other events that do not currently
* have goals.
* LaunchDarkly automatically tracks pageviews and clicks that are specified in the Metrics section
* of the dashboard. This can be used to track custom metrics (goals) or other events that do not currently
* have metrics.
*
* Note that event delivery is asynchronous, so the event may not actually be sent until later;
* see {@link flush}.
*
* If the context is omitted or has no key, the client will log a warning and will not send an
* event.
*
* @param key The name of the event, which may correspond to a goal in A/B tests.
* @param key The name of the event, which may correspond to a metric in Experimentation.
* @param context The context to track.
* @param data Optional additional information to associate with the event.
* @param metricValue A numeric value used by the LaunchDarkly experimentation feature in numeric
Expand Down