Comments

1 files changed, 3 insertions, 0 deletions

diff --git a/synapse/util/dictionary_cache.py b/synapse/util/dictionary_cache.py

index 38b131677c..c7564cdf0d 100644
--- a/synapse/util/dictionary_cache.py
+++ b/synapse/util/dictionary_cache.py
@@ -26,6 +26,9 @@ DictionaryEntry = namedtuple("DictionaryEntry", ("full", "value"))
 
 
 class DictionaryCache(object):
+    """Caches key -> dictionary lookups, supporting caching partial dicts, i.e.
+    fetching a subset of dictionary keys for a particular key.
+    """
 
     def __init__(self, name, max_entries=1000):
         self.cache = LruCache(max_size=max_entries)