From f6f079be4151d24363665bc8020efb5ca44a9fa8 Mon Sep 17 00:00:00 2001
From: Eric Eastwood <erice@element.io>
Date: Tue, 24 Jun 2025 18:36:16 -0500
Subject: [PATCH] Better docstring

---
 synapse/metrics/__init__.py | 7 +++++--
 1 file changed, 5 insertions(+), 2 deletions(-)

diff --git a/synapse/metrics/__init__.py b/synapse/metrics/__init__.py
index 634582749b..cebc713699 100644
--- a/synapse/metrics/__init__.py
+++ b/synapse/metrics/__init__.py
@@ -69,8 +69,8 @@ HAVE_PROC_SELF_STAT = os.path.exists("/proc/self/stat")
 
 class CombinedRegistryProxy:
     """
-    Wrapper around the global Prometheus metric registry so we can also include our
-    homeserver-specific metrics.
+    Wrapper that combines multiple Prometheus `CollectorRegistry` instances, presenting
+    them as a single unified registry when collecting metrics.
 
     Usage:
     ```python
@@ -78,6 +78,9 @@ class CombinedRegistryProxy:
         homeserver_metrics_collector_registry,
         prometheus_client.REGISTRY
     ])
+    # Cheeky cast but matches the signature of a `CollectorRegistry` instance enough
+    # for it to be usable in the contexts in which we use it.
+    # TODO Do something nicer about this.
     registry = cast(CollectorRegistry, combined_registry_proxy)
     ```
     """