summary refs log tree commit diff
diff options
context:
space:
mode:
authorAndrew Morgan <andrew@amorgan.xyz>2021-10-20 17:10:45 +0100
committerAndrew Morgan <andrew@amorgan.xyz>2021-10-20 17:11:45 +0100
commit1e5a0f2fea1a8e30da0f79f25b88a2011588ab41 (patch)
tree5a6faabe477dd5a3af7c3cd9aaf65f06adb7d6b6
parentAdd docstring to on_new_event (diff)
downloadsynapse-1e5a0f2fea1a8e30da0f79f25b88a2011588ab41.tar.xz
Add docstring to _notify_app_services_ephemeral
-rw-r--r--synapse/notifier.py9
1 files changed, 8 insertions, 1 deletions
diff --git a/synapse/notifier.py b/synapse/notifier.py
index 37513f2b35..1acd899fab 100644
--- a/synapse/notifier.py
+++ b/synapse/notifier.py
@@ -379,7 +379,14 @@ class Notifier:
         stream_key: str,
         new_token: Union[int, RoomStreamToken],
         users: Optional[Collection[Union[str, UserID]]] = None,
-    ):
+    ) -> None:
+        """Notify application services of ephemeral event activity.
+
+        Args:
+            stream_key: The stream the event came from.
+            new_token: The value of the new stream token.
+            users: The users that should be informed of the new event, if any.
+        """
         try:
             stream_token = None
             if isinstance(new_token, int):