diff options
| author | Amber Brown <hawkowl@atleastfornow.net> | 2018-09-27 18:06:38 +1000 |
|---|---|---|
| committer | GitHub <noreply@github.com> | 2018-09-27 18:06:38 +1000 |
| commit | 2c695fd1aa6f5d905ea45006866140ad23665441 (patch) | |
| tree | d21e8e875206059b86f727e0934e91efa00a5bc2 | |
| parent | Reduce the load on our CI (#3957) (diff) | |
| parent | changelog (diff) | |
| download | synapse-2c695fd1aa6f5d905ea45006866140ad23665441.tar.xz | |
Merge pull request #3963 from matrix-org/rav/get_state_for_room_docstring
fix docstring for FederationClient.get_state_for_room
| -rw-r--r-- | changelog.d/3963.misc | 1 | ||||
| -rw-r--r-- | synapse/federation/federation_client.py | 8 |
2 files changed, 5 insertions, 4 deletions
diff --git a/changelog.d/3963.misc b/changelog.d/3963.misc new file mode 100644 index 0000000000..f1e0eaf18e --- /dev/null +++ b/changelog.d/3963.misc @@ -0,0 +1 @@ +fix docstring for FederationClient.get_state_for_room 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. |