Skip to content

Commit d7a0b09

Browse files
authored
Update docs to remove references from V3 (#420)
1 parent d363ae1 commit d7a0b09

2 files changed

Lines changed: 6 additions & 4 deletions

File tree

lib/cachex.ex

Lines changed: 5 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -188,7 +188,7 @@ defmodule Cachex do
188188
The `:hooks` option allow the user to attach a list of notification hooks to
189189
enable listening on cache actions (either before or after they happen). These
190190
hooks should be valid `:hook` records provided by `Cachex.Spec`. Example hook
191-
implementations can be found in `Cachex.Stats` and `Cachex.Policy.LRW`.
191+
implementations can be found in `Cachex.Stats` and `Cachex.Limited.Scheduled`.
192192
193193
iex> import Cachex.Spec
194194
...>
@@ -795,8 +795,10 @@ defmodule Cachex do
795795
796796
iex> Cachex.inspect(:my_cache, :cache)
797797
{:ok,
798-
{:cache, :my_cache, %{}, {:expiration, nil, 3000, true}, {:fallback, nil, nil},
799-
{:hooks, [], []}, {:limit, nil, Cachex.Policy.LRW, 0.1, []}, false, []}}
798+
{:cache, :my_cache, %{}, false, {:expiration, nil, 3000, true},
799+
{:hooks, [], [{:hook, Cachex.Stats, nil, #PID<0.986.0>}]},
800+
[{:hook, Cachex.Limit.Scheduled, {500, [], []}, #PID<0.985.0>}], nil, false,
801+
{:router, [], Cachex.Router.Local, nil}, false, []}}
800802
801803
iex> Cachex.inspect(:my_cache, { :entry, "my_key" } )
802804
{ :ok, { :entry, "my_key", 1475476615662, 1, "my_value" } }

lib/cachex/limit/scheduled.ex

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -4,7 +4,7 @@ defmodule Cachex.Limit.Scheduled do
44
55
This module implements a scheduled LRW eviction policy for Cachex, using a basic
66
timer to trigger bound enforcement in a repeatable way. This has the same bound
7-
accuracy as `Cachex.Policy.LRW.Evented`, but has potential for some delay. The
7+
accuracy as `Cachex.Limit.Evented`, but has potential for some delay. The
88
main advantage of this implementation is a far lower memory cost due to not
99
using hook messages.
1010

0 commit comments

Comments
 (0)