From 8e758f1e4fa547689fafead1720672bb7a1899f3 Mon Sep 17 00:00:00 2001 From: Shay Palachy Date: Mon, 29 Aug 2016 00:17:36 +0300 Subject: [PATCH] Update README.rst --- README.rst | 4 +++- 1 file changed, 3 insertions(+), 1 deletion(-) diff --git a/README.rst b/README.rst index 7ef7674..62e3580 100644 --- a/README.rst +++ b/README.rst @@ -51,9 +51,11 @@ Cachier is not: Use --- +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. + Pickle-based Caching ~~~~~~~~~~~~~~~~~~~~ -You can add a deafult, pickle-based persistent cache to your function by decorating it with the ``cachier`` decorator (notice the ``()``!). +You can add a deafult, pickle-based persistent cache to your function - meaning it will last across different Python kernels calling the wrapped function - by decorating it with the ``cachier`` decorator (notice the ``()``!). .. code-block:: python