From 289a4abdd813e38015d15af19860a5a3552642db Mon Sep 17 00:00:00 2001 From: tyiuhc Date: Fri, 2 Feb 2024 13:24:25 -0800 Subject: [PATCH] update docs --- lib/experiment/factory.rb | 6 ++++-- lib/experiment/local/config.rb | 2 +- lib/experiment/remote/config.rb | 2 +- 3 files changed, 6 insertions(+), 4 deletions(-) diff --git a/lib/experiment/factory.rb b/lib/experiment/factory.rb index 2d4304f..446f538 100644 --- a/lib/experiment/factory.rb +++ b/lib/experiment/factory.rb @@ -6,7 +6,8 @@ module AmplitudeExperiment # Initializes a singleton Client. This method returns a default singleton instance, subsequent calls to # init will return the initial instance regardless of input. # - # @param [String] api_key The environment API Key. If a deployment key is provided in the config, it will be used instead. + # @param [String] api_key The Amplitude Project API Key used in the client. If a deployment key is provided in + # the config, it will be used instead. # @param [Config] config Optional Config. def self.initialize_remote(api_key, config = nil) used_key = config&.deployment_key.nil? ? api_key : config.deployment_key @@ -18,7 +19,8 @@ def self.initialize_remote(api_key, config = nil) # user without requiring a remote call to the amplitude evaluation server. In order to best leverage local # evaluation, all flags, and experiments being evaluated server side should be configured as local. # - # @param [String] api_key The environment API Key. If a deployment key is provided in the config, it will be used instead. + # @param [String] api_key The Amplitude Project API Key used in the client. If a deployment key is provided in + # the config, it will be used instead. # @param [Config] config Optional Config. def self.initialize_local(api_key, config = nil) used_key = config&.deployment_key.nil? ? api_key : config.deployment_key diff --git a/lib/experiment/local/config.rb b/lib/experiment/local/config.rb index 7ab90be..08c5c07 100644 --- a/lib/experiment/local/config.rb +++ b/lib/experiment/local/config.rb @@ -20,7 +20,7 @@ class LocalEvaluationConfig # @return [AssignmentConfig] the config instance attr_accessor :assignment_config - # The deployment key for the experiment. If provided, it is used instead of the Project API Key. + # The deployment key for the experiment. If provided, it is used instead of the Amplitude Project API Key. # @return [String] the value of deployment_key attr_accessor :deployment_key diff --git a/lib/experiment/remote/config.rb b/lib/experiment/remote/config.rb index f775683..681f236 100644 --- a/lib/experiment/remote/config.rb +++ b/lib/experiment/remote/config.rb @@ -38,7 +38,7 @@ class RemoteEvaluationConfig # @return [Integer] the value of fetch_retry_timeout_millis attr_accessor :fetch_retry_timeout_millis - # The deployment key for the experiment. If provided, it is used instead of the Project API Key. + # The deployment key for the experiment. If provided, it is used instead of the Amplitude Project API Key. # @return [String] the value of deployment_key attr_accessor :deployment_key