Mirrors
/
synapse-old
mirror of https://github.com/matrix-org/synapse.git
1
0
Fork 0
Code Issues Packages Projects Releases Wiki Activity

Re-add docstring, with caveats detailed

This commit is contained in:
Andrew Morgan 2019-11-04 18:17:11 +00:00
parent 0287d033ee
commit c2203bea57
3 changed files with 7 additions and 3 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

6
synapse/storage/data_stores/main/state.py
View File

@ -285,7 +285,11 @@ class StateGroupWorkerStore(
room_id (str)
Returns:
Deferred[unicode|None]: predecessor room id
Deferred[dict|None]: A dictionary containing the structure of the predecessor
field from the room's create event. The structure is subject to other servers,
but it is expected to be:
* room_id (str): The room ID of the predecessor room
* event_id (str): The ID of the tombstone event in the predecessor room
Raises:
NotFoundError if the room is unknown