From 1e217ec044e9df31379e721d7b984e002c3fd2a3 Mon Sep 17 00:00:00 2001 From: MattC Date: Wed, 3 Aug 2022 12:45:38 +1000 Subject: [PATCH] Document - add some spacing to the module API "lookup_room_alias" docstring. --- synapse/module_api/__init__.py | 2 ++ 1 file changed, 2 insertions(+) diff --git a/synapse/module_api/__init__.py b/synapse/module_api/__init__.py index dd4d18545f06..4251617ce2f1 100644 --- a/synapse/module_api/__init__.py +++ b/synapse/module_api/__init__.py @@ -1461,10 +1461,12 @@ async def lookup_room_alias(self, room_alias: str) -> Tuple[str, List[str]]: Args: room_alias: The alias to look up. + Returns: A tuple of: The room ID (str). Hosts likely to be participating in the room ([str]). + Raises: SynapseError if room alias is invalid or could not be found. """