add docstring comment to Entry constructor

- specify the time increment (seconds)
workos · Jan 16, 2025 · 2f20578 · 2f20578
1 parent 87e28cd
commit 2f20578
Showing 1 changed file with 3 additions and 0 deletions.
diff --git a/lib/workos/cache.rb b/lib/workos/cache.rb
@@ -8,6 +8,9 @@ module Cache
     class Entry
       attr_reader :value, :expires_at
 
+      # Initializes a new cache entry
+      # @param value [Object] The value to store in the cache
+      # @param expires_in [Integer, nil] The expiration time for the value in seconds, or nil for no expiration
       def initialize(value, expires_in)
         @value = value
         @expires_at = expires_in ? Time.now + expires_in : nil