Add YARD comments

Author: marksmith

lib/aikido/zen/rate_limiter/bucket.rb

@@ -29,9 +29,15 @@ class RateLimiter::Bucket
     # @!visibility private
     #
     # Use the monotonic clock to ensure time differences are consistent
-    # and not affected by timezones.or daylight savings changes.
+    # and not affected by timezones or daylight savings changes.
     DEFAULT_CLOCK = -> { Process.clock_gettime(Process::CLOCK_MONOTONIC).round }
 
+    # @param ttl [Integer] the time to live in seconds
+    # @param max_size [Integer] the number of requests before throttling
+    # @param clock [#call() => Integer] a callable that returns the current
+    #   monotonic time in seconds
+    # @param settings [Aikido::Zen::RuntimeSettings::RateLimitSettings, nil]
+    #   the settings that might change
     def initialize(ttl:, max_size:, clock: DEFAULT_CLOCK, settings: nil)
       @ttl = ttl
       @max_size = max_size
@@ -68,10 +74,13 @@ def increment(key)
       end
     end
 
+    # Checks whether the settings provided at initialization have changed.
+    #
+    # @param settings [Aikido::Zen::RuntimeSettings::RateLimitSettings]
+    # @return [Boolean] true if settings were provided at initialization and
+    #   the settings have changed
     def settings_changed?(settings)
-      return false if @settings.nil?
-
-      @settings != settings
+      !@settings.nil? && @settings != settings
     end
 
     private