Document AS::Cache::Store#read options [ci-skip]

jonathanhefner · jonathanhefner · commit f7a82bf5465e · 2022-08-09T12:25:56.000-05:00
(cherry picked from commit a95438c)
diff --git a/activesupport/lib/active_support/cache.rb b/activesupport/lib/active_support/cache.rb
@@ -342,7 +342,13 @@ def fetch(name, options = nil, &block)
       # <tt>:version</tt> options, both of these conditions are applied before
       # the data is returned.
       #
-      # Options are passed to the underlying cache implementation.
+      # ==== Options
+      #
+      # * +:version+ - Specifies a version for the cache entry. If the cached
+      #   version does not match the requested version, the read will be treated
+      #   as a cache miss. This feature is used to support recyclable cache keys.
+      #
+      # Other options will be handled by the specific cache store implementation.
       def read(name, options = nil)
         options = merged_options(options)
         key     = normalize_key(name, options)
