diff options
| author | Richard van der Hoff <richard@matrix.org> | 2018-09-25 16:53:55 +0100 |
|---|---|---|
| committer | Richard van der Hoff <richard@matrix.org> | 2018-09-26 16:52:24 +0100 |
| commit | 607eec0456dde3b7e5b33c3e9297af234659caae (patch) | |
| tree | db298c534d5b58407596d7266a688cc3afa9e366 | |
| parent | Reduce the load on our CI (#3957) (diff) | |
| download | synapse-607eec0456dde3b7e5b33c3e9297af234659caae.tar.xz | |
fix docstring for FederationClient.get_state_for_room
trivial fixes for docstring
| -rw-r--r-- | synapse/federation/federation_client.py | 8 |
1 files changed, 4 insertions, 4 deletions
diff --git a/synapse/federation/federation_client.py b/synapse/federation/federation_client.py index 5a92428f56..8bf1ad0c1f 100644 --- a/synapse/federation/federation_client.py +++ b/synapse/federation/federation_client.py @@ -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. |