summary refs log tree commit diff
diff options
context:
space:
mode:
authorDavid Baker <dave@matrix.org>2018-11-09 13:25:38 +0000
committerDavid Baker <dave@matrix.org>2018-11-09 13:25:38 +0000
commit4f93abd62d6800c00c9e943f75e19e09c98c8f30 (patch)
tree8c09cf30b8bc31e6c1fe948808b0ee0382df075a
parentRemove unnecessary str() (diff)
downloadsynapse-4f93abd62d6800c00c9e943f75e19e09c98c8f30.tar.xz
add docs
-rw-r--r--synapse/storage/e2e_room_keys.py5
1 files changed, 4 insertions, 1 deletions
diff --git a/synapse/storage/e2e_room_keys.py b/synapse/storage/e2e_room_keys.py
index a1d203fd61..5d83707fa0 100644
--- a/synapse/storage/e2e_room_keys.py
+++ b/synapse/storage/e2e_room_keys.py
@@ -217,7 +217,10 @@ class EndToEndRoomKeyStore(SQLBaseStore):
         Raises:
             StoreError: with code 404 if there are no e2e_room_keys_versions present
         Returns:
-            A deferred dict giving the info metadata for this backup version
+            A deferred dict giving the info metadata for this backup version, with fields including:
+                version(str)
+                algorithm(str)
+                auth_data(object): opaque dict supplied by the client
         """
 
         def _get_e2e_room_keys_version_info_txn(txn):