Skip to content
This repository has been archived by the owner on Apr 26, 2024. It is now read-only.

Commit

Permalink
Document - Tidy up the docstring for the "create_room" module API met…
Browse files Browse the repository at this point in the history
…hod.
  • Loading branch information
buffless-matt committed Aug 3, 2022
1 parent 549b685 commit cdf27d5
Showing 1 changed file with 3 additions and 2 deletions.
5 changes: 3 additions & 2 deletions synapse/module_api/__init__.py
Original file line number Diff line number Diff line change
Expand Up @@ -1480,12 +1480,13 @@ async def create_room(
Returns:
A tuple containing the room ID (str) and, if an alias was requested,
the room alias (str), otherwise None (if no alias was requested).
Raises:
SynapseError if the user_id is invalid, room ID couldn't be stored, or
something went horribly wrong.
ResourceLimitError if server is blocked to some resource being
exceeded.
RuntimeError if the user_id does not refer to a local user.
SynapseError if the user_id is invalid, room ID couldn't be stored, or
something went horribly wrong.
"""
if not self.is_mine(user_id):
raise RuntimeError(
Expand Down

0 comments on commit cdf27d5

Please sign in to comment.