summary refs log tree commit diff
diff options
context:
space:
mode:
authorErik Johnston <erik@matrix.org>2022-07-18 10:49:12 +0100
committerErik Johnston <erik@matrix.org>2022-07-18 10:49:12 +0100
commit129691f19096c2dc0c652a6eeceebffd60978545 (patch)
tree19ed1518a69c37b4a7712b85723392508a7d61f1
parentComment LruCache (diff)
downloadsynapse-129691f19096c2dc0c652a6eeceebffd60978545.tar.xz
Comment TreeCache
-rw-r--r--synapse/util/caches/treecache.py3
1 files changed, 3 insertions, 0 deletions
diff --git a/synapse/util/caches/treecache.py b/synapse/util/caches/treecache.py
index c089cb89f4..c0136ea269 100644
--- a/synapse/util/caches/treecache.py
+++ b/synapse/util/caches/treecache.py
@@ -144,6 +144,9 @@ def iterate_tree_cache_entry(d):
 def iterate_tree_cache_items(key, value):
     """Helper function to iterate over the leaves of a tree, i.e. a dict of that
     can contain dicts.
+
+    Returns:
+        A generator yielding key/value pairs.
     """
     if isinstance(value, TreeCacheNode):
         for sub_key, sub_value in value.items():