mirror of
https://github.com/element-hq/synapse
synced 2024-08-20 21:20:21 +00:00
Merge pull request #3963 from matrix-org/rav/get_state_for_room_docstring
fix docstring for FederationClient.get_state_for_room
This commit is contained in:
commit
2c695fd1aa
2 changed files with 5 additions and 4 deletions
1
changelog.d/3963.misc
Normal file
1
changelog.d/3963.misc
Normal file
|
@ -0,0 +1 @@
|
|||
fix docstring for FederationClient.get_state_for_room
|
|
@ -289,8 +289,7 @@ class FederationClient(FederationBase):
|
|||
@defer.inlineCallbacks
|
||||
@log_function
|
||||
def get_state_for_room(self, destination, room_id, event_id):
|
||||
"""Requests all of the `current` state PDUs for a given room from
|
||||
a remote home server.
|
||||
"""Requests all of the room state at a given event from a remote home server.
|
||||
|
||||
Args:
|
||||
destination (str): The remote homeserver to query for the state.
|
||||
|
@ -298,9 +297,10 @@ class FederationClient(FederationBase):
|
|||
event_id (str): The id of the event we want the state at.
|
||||
|
||||
Returns:
|
||||
Deferred: Results in a list of PDUs.
|
||||
Deferred[Tuple[List[EventBase], List[EventBase]]]:
|
||||
A list of events in the state, and a list of events in the auth chain
|
||||
for the given event.
|
||||
"""
|
||||
|
||||
try:
|
||||
# First we try and ask for just the IDs, as thats far quicker if
|
||||
# we have most of the state and auth_chain already.
|
||||
|
|
Loading…
Reference in a new issue