From eaa836e8cafd2254e73b935dc1e471f784b30773 Mon Sep 17 00:00:00 2001
From: David Baker <dave@matrix.org>
Date: Fri, 22 Jan 2016 11:47:22 +0000
Subject: Docs for treecache

---
 synapse/util/caches/treecache.py | 5 +++++
 1 file changed, 5 insertions(+)

(limited to 'synapse/util')

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 = {}
 
-- 
cgit 1.4.1