summary refs log tree commit diff
diff options
context:
space:
mode:
authorDavid Baker <dave@matrix.org>2016-01-22 11:47:22 +0000
committerDavid Baker <dave@matrix.org>2016-01-22 11:47:22 +0000
commiteaa836e8cafd2254e73b935dc1e471f784b30773 (patch)
tree1b85252d0f949abef6ab738eb8317b41e8ecab34
parentUse new invalidate_many cache invalidation to invalidate the event_push_actio... (diff)
downloadsynapse-eaa836e8cafd2254e73b935dc1e471f784b30773.tar.xz
Docs for treecache
-rw-r--r--synapse/util/caches/treecache.py5
1 files changed, 5 insertions, 0 deletions
diff --git a/synapse/util/caches/treecache.py b/synapse/util/caches/treecache.py
index 6faf2cf75f..2d014e1f92 100644
--- a/synapse/util/caches/treecache.py
+++ b/synapse/util/caches/treecache.py
@@ -2,6 +2,11 @@ SENTINEL = object()
 
 
 class TreeCache(object):
+    """
+    Tree-based backing store for LruCache. Allows subtrees of data to be deleted
+    efficiently.
+    Keys must be tuples.
+    """
     def __init__(self):
         self.root = {}