aboutsummaryrefslogtreecommitdiffstats
path: root/activesupport/lib
diff options
context:
space:
mode:
authorSteven Harman <steven@harmanly.com>2019-04-18 17:29:22 -0400
committerJeremy Daer <jeremydaer@gmail.com>2019-04-18 15:19:53 -0700
commit8fc6ec73a406aa8b6cccd450d08f42e33e419b2c (patch)
tree333b53bf646e88824357960b95c4136fecd0068e /activesupport/lib
parent4acddae05e65ec62114219d0595d78bd13ed889d (diff)
downloadrails-8fc6ec73a406aa8b6cccd450d08f42e33e419b2c.tar.gz
rails-8fc6ec73a406aa8b6cccd450d08f42e33e419b2c.tar.bz2
rails-8fc6ec73a406aa8b6cccd450d08f42e33e419b2c.zip
Document redis: Object option
There are four ways to pass the redis option, but only three were documented. This is now consistent with implementation. [ci skip]
Diffstat (limited to 'activesupport/lib')
-rw-r--r--activesupport/lib/active_support/cache/redis_cache_store.rb12
1 files changed, 7 insertions, 5 deletions
diff --git a/activesupport/lib/active_support/cache/redis_cache_store.rb b/activesupport/lib/active_support/cache/redis_cache_store.rb
index 87f9aa5346..bb092fcde9 100644
--- a/activesupport/lib/active_support/cache/redis_cache_store.rb
+++ b/activesupport/lib/active_support/cache/redis_cache_store.rb
@@ -152,12 +152,14 @@ module ActiveSupport
# Creates a new Redis cache store.
#
- # Handles three options: block provided to instantiate, single URL
- # provided, and multiple URLs provided.
+ # Handles four options: :redis block, :redis instance, single :url
+ # string, and multiple :url strings.
#
- # :redis Proc -> options[:redis].call
- # :url String -> Redis.new(url: …)
- # :url Array -> Redis::Distributed.new([{ url: … }, { url: … }, …])
+ # Option Class Result
+ # :redis Proc -> options[:redis].call
+ # :redis Object -> options[:redis]
+ # :url String -> Redis.new(url: …)
+ # :url Array -> Redis::Distributed.new([{ url: … }, { url: … }, …])
#
# No namespace is set by default. Provide one if the Redis cache
# server is shared with other apps: <tt>namespace: 'myapp-cache'</tt>.