summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorJay Hutchinson <jlhutch@gmail.com>2019-03-12 11:46:39 -0500
committerJay Hutchinson <jlhutch@gmail.com>2019-03-12 11:46:39 -0500
commitc1adbc9c1c6ade972eba044c172ca8626a4a4823 (patch)
treed531338534f6c5253eb677e5833eeee14c272cd1
parent3702264294061a3ebd6d3547566012dbbbdd0e6a (diff)
downloadpylru-c1adbc9c1c6ade972eba044c172ca8626a4a4823.tar.gz
Updated documentation.
-rw-r--r--README.txt4
1 files changed, 2 insertions, 2 deletions
diff --git a/README.txt b/README.txt
index 3c84aa9..46377c2 100644
--- a/README.txt
+++ b/README.txt
@@ -209,7 +209,7 @@ To help the programmer ensure that the final sync() is called, WriteBackCacheMan
FunctionCacheManager
---------------------
-FunctionCacheManager allows you to compose a function with an lrucache. The resulting object can be called just like the original function, but the results are cached to speed up future calls. The fuction must have arguments that are hashable::
+FunctionCacheManager allows you to compose a function with an lrucache. The resulting object can be called just like the original function, but the results are cached to speed up future calls. The function must have arguments that are hashable. FunctionCacheManager takes an optional callback function as a third argument::
import pylru
@@ -235,7 +235,7 @@ FunctionCacheManager allows you to compose a function with an lrucache. The resu
lrudecorator
------------
-PyLRU also provides a function decorator. This is basically the same functionality as FunctionCacheManager, but in the form of a decorator::
+PyLRU also provides a function decorator. This is basically the same functionality as FunctionCacheManager, but in the form of a decorator. The decorator takes an optional callback function as a second argument::
from pylru import lrudecorator