Doc-string for config ultility function

1 files changed, 11 insertions, 0 deletions

diff --git a/synapse/config/repository.py b/synapse/config/repository.py
index 7cab874422..2cb0812d7d 100644
--- a/synapse/config/repository.py
+++ b/synapse/config/repository.py
@@ -21,6 +21,17 @@ ThumbnailRequirement = namedtuple(
 )
 
 def parse_thumbnail_requirements(thumbnail_sizes):
+    """ Takes a list of dictionaries with "width", "height", and "method" keys
+    and creates a map from image media types to the thumbnail size, thumnailing
+    method, and thumbnail media type to precalculate
+
+    Args:
+        thumbnail_sizes(list): List of dicts with "width", "height", and
+            "method" keys
+    Returns:
+        Dictionary mapping from media type string to list of
+        ThumbnailRequirement tuples.
+    """
     requirements = {}
     for size in thumbnail_sizes:
         width = size["width"]