update docs

amplitude · Feb 2, 2024 · 289a4ab · 289a4ab
1 parent f7a8207
commit 289a4ab
Show file tree

Hide file tree

Showing 3 changed files with 6 additions and 4 deletions.
diff --git 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
@@ -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
@@ -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