From b947a74173ac06f82b84e2e7a65a547ae06a7f06 Mon Sep 17 00:00:00 2001 From: Shay Palachy Date: Sat, 8 Feb 2020 19:16:04 +0200 Subject: [PATCH] readme update --- README.rst | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/README.rst b/README.rst index 1a15e84..735f910 100644 --- a/README.rst +++ b/README.rst @@ -69,7 +69,7 @@ Future features Use === -Cachier provides a decorator which you can wrap around your functions to give them a persistent cache. The positional and keyword arguments to the wrapped function must be hashable (i.e. Python's immutable built-in objects, not mutable containers). Also, notice that since objects which are instances of user-defined classes are hashable but all compare unequal (their hash value is their id), equal objects across different sessions will not yield identical keys. +Cachier provides a decorator which you can wrap around your functions to give them a persistent cache. The positional and keyword arguments to the wrapped function must be hashable (i.e. Python's immutable built-in objects, not mutable containers), or pickle-able objects. Also, notice that since objects which are instances of user-defined classes are hashable but all compare unequal (their hash value is their id), equal objects across different sessions will not yield identical keys. Setting up a Cache ------------------