From 129691f19096c2dc0c652a6eeceebffd60978545 Mon Sep 17 00:00:00 2001
From: Erik Johnston <erik@matrix.org>
Date: Mon, 18 Jul 2022 10:49:12 +0100
Subject: [PATCH] Comment TreeCache

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

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():