clean up and link docs

Author: jsonbailey

lib/ldclient-rb/impl/datasystem.rb

@@ -22,6 +22,8 @@ module DataSystem
       # This method will return immediately. The returned event will be set when the system
       # has reached an initial state (either permanently failed, e.g. due to bad auth, or succeeded).
       #
+      # If called multiple times, returns the same event as the first call.
+      #
       # @return [Concurrent::Event] Event that will be set when initialization is complete
       #
       def start
@@ -30,7 +32,7 @@ def start
 
       #
       # Halts the data system. Should be called when the client is closed to stop any long running
-      # operations.
+      # operations. Makes the data system no longer usable.
       #
       # @return [void]
       #
@@ -80,7 +82,9 @@ def flag_change_broadcaster
       #
       # Indicates what form of data is currently available.
       #
-      # @return [Symbol] One of DataAvailability constants
+      # This is calculated dynamically based on current system state.
+      #
+      # @return [Symbol] one of the {DataAvailability} constants
       #
       def data_availability
         raise NotImplementedError, "#{self.class} must implement #data_availability"
@@ -89,7 +93,7 @@ def data_availability
       #
       # Indicates the ideal form of data attainable given the current configuration.
       #
-      # @return [Symbol] One of DataAvailability constants
+      # @return [Symbol] one of the {#DataAvailability} constants
       #
       def target_availability
         raise NotImplementedError, "#{self.class} must implement #target_availability"

lib/ldclient-rb/impl/datasystem/fdv1.rb

@@ -12,6 +12,8 @@ module DataSystem
       # FDv1 wires the existing v1 data source and store behavior behind the
       # generic DataSystem surface.
       #
+      # @see DataSystem
+      #
       class FDv1
         include LaunchDarkly::Impl::DataSystem
 
@@ -68,85 +70,48 @@ def initialize(sdk_key, config)
           @diagnostic_accumulator = nil
         end
 
-        #
-        # Starts the v1 update processor and returns immediately. The returned event
-        # will be set by the processor upon first successful initialization or upon permanent failure.
-        #
-        # If called multiple times, returns the same event as the first call. The update
-        # processor is created only once, and subsequent calls delegate to the processor's
-        # own start method which handles multiple invocations.
-        #
-        # @return [Concurrent::Event] Event that will be set when initialization is complete
-        #
+        # (see DataSystem#start)
         def start
           @update_processor ||= make_update_processor
           @update_processor.start
         end
 
-        #
-        # Halts the data system, stopping the update processor and shutting down the executor,
-        # making the data system no longer usable.
-        #
-        # @return [void]
-        #
+        # (see DataSystem#stop)
         def stop
           @update_processor&.stop
           @shared_executor.shutdown
         end
 
-        #
-        # Returns the feature store wrapper used by this data system.
-        #
-        # @return [LaunchDarkly::Impl::DataStore::ClientWrapper]
-        #
+        # (see DataSystem#store)
         def store
           @store_wrapper
         end
 
-        #
-        # Sets the diagnostic accumulator for streaming initialization metrics.
-        # This should be called before start() to ensure metrics are collected.
-        #
-        # @param diagnostic_accumulator [DiagnosticAccumulator] The diagnostic accumulator
-        # @return [void]
-        #
+        # (see DataSystem#set_diagnostic_accumulator)
         def set_diagnostic_accumulator(diagnostic_accumulator)
           @diagnostic_accumulator = diagnostic_accumulator
         end
 
-        #
-        # Returns the data source status provider.
-        #
-        # @return [LaunchDarkly::Interfaces::DataSource::StatusProvider]
-        #
+        # (see DataSystem#data_source_status_provider)
         def data_source_status_provider
           @data_source_status_provider
         end
 
-        #
-        # Returns the data store status provider.
-        #
-        # @return [LaunchDarkly::Interfaces::DataStore::StatusProvider]
-        #
+        # (see DataSystem#data_store_status_provider)
         def data_store_status_provider
           @data_store_status_provider
         end
 
-        #
-        # Returns the broadcaster for flag change notifications.
-        #
-        # @return [LaunchDarkly::Impl::Broadcaster]
-        #
+        # (see DataSystem#flag_change_broadcaster)
         def flag_change_broadcaster
           @flag_change_broadcaster
         end
 
         #
-        # Indicates what form of data is currently available.
-        #
-        # This is calculated dynamically based on current system state.
+        # (see DataSystem#data_availability)
         #
-        # @return [Symbol] One of DataAvailability constants
+        # In LDD mode, always returns CACHED for backwards compatibility,
+        # even if the store is empty.
         #
         def data_availability
           return DataAvailability::DEFAULTS if @config.offline?
@@ -163,11 +128,7 @@ def data_availability
           DataAvailability::DEFAULTS
         end
 
-        #
-        # Indicates the ideal form of data attainable given the current configuration.
-        #
-        # @return [Symbol] One of DataAvailability constants
-        #
+        # (see DataSystem#target_availability)
         def target_availability
           return DataAvailability::DEFAULTS if @config.offline?
           return DataAvailability::CACHED if @config.use_ldd?