kotovalexarian-likes-github/rails--rails
1
0
Fork 0
mirror of https://github.com/rails/rails.git synced 2022-11-09 12:12:34 -05:00
Code Releases Activity

Document redis: Object option

Browse source 
There are four ways to pass the redis option, but only three were
documented. This is now consistent with implementation.

[ci skip]
This commit is contained in:
Steven Harman 2019-04-18 17:29:22 -04:00 committed by Jeremy Daer
parent 4acddae05e
commit 8fc6ec73a4
1 changed files with 7 additions and 5 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

12
activesupport/lib/active_support/cache/redis_cache_store.rb vendored
View file

@ -152,12 +152,14 @@ module ActiveSupport
# Creates a new Redis cache store. # Creates a new Redis cache store.
# #
# Handles three options: block provided to instantiate, single URL # Handles four options: :redis block, :redis instance, single :url
# provided, and multiple URLs provided. # string, and multiple :url strings.
# #
# :redis Proc -> options[:redis].call # Option Class Result
# :url String -> Redis.new(url: …) # :redis Proc -> options[:redis].call
# :url Array -> Redis::Distributed.new([{ url: … }, { url: … }, …]) # :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 # No namespace is set by default. Provide one if the Redis cache
# server is shared with other apps: <tt>namespace: 'myapp-cache'</tt>. # server is shared with other apps: <tt>namespace: 'myapp-cache'</tt>.