From 97361ccfda56da9c415b7c89cc496333e8712bfe Mon Sep 17 00:00:00 2001 From: Frames White Date: Tue, 19 Mar 2024 01:43:47 +0800 Subject: [PATCH] explain more about usage --- README.md | 3 +++ 1 file changed, 3 insertions(+) diff --git a/README.md b/README.md index 9364429..39c9eb9 100644 --- a/README.md +++ b/README.md @@ -18,5 +18,8 @@ It is thread-safe, and doesn't leak memory. We expose just two functions `new_cache(T, args...; kwargs...)` to create new tracked caches by calling `T(args...; kwargs...)`; and `clear_all_caches()!` which calls `empty!` on all caches that are tracked (and haven't been GCed already). +Generally you would never all `clear_all_caches` in your code, but rather you would call it manually from the REPL while interactively developing. +Be generally aware that declaring a cache using `new_cache` means someone else (developing some other package) might cause it to be cleared. +By the nature of it being a cache this should always be fine, but exceptions are exceptional.