From 795d0584f611bc6a67ed0f7f041141c062cbc642 Mon Sep 17 00:00:00 2001 From: Andrew Morgan Date: Wed, 20 Oct 2021 17:11:37 +0100 Subject: [PATCH] Add docstring to on_new_event --- synapse/notifier.py | 9 ++++++++- 1 file changed, 8 insertions(+), 1 deletion(-) diff --git a/synapse/notifier.py b/synapse/notifier.py index 1a9f84ba45..37513f2b35 100644 --- a/synapse/notifier.py +++ b/synapse/notifier.py @@ -402,10 +402,17 @@ class Notifier: new_token: Union[int, RoomStreamToken], users: Optional[Collection[Union[str, UserID]]] = None, rooms: Optional[Collection[str]] = None, - ): + ) -> None: """Used to inform listeners that something has happened event wise. Will wake up all listeners for the given users and rooms. + + 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. + rooms: A collection of room IDs for which each joined member will be + informed of the new event. """ users = users or [] rooms = rooms or []