summary refs log tree commit diff
path: root/synapse/storage/state.py
diff options
context:
space:
mode:
authorMark Haines <mark.haines@matrix.org>2016-04-01 16:08:59 +0100
committerMark Haines <mark.haines@matrix.org>2016-04-01 16:12:07 +0100
commit2a37467fa1358eb41513893efe44cbd294dca36c (patch)
tree5d07ebcf930104318f74862ba54db5074a23917b /synapse/storage/state.py
parentMerge pull request #680 from matrix-org/markjh/remove_is_new_state (diff)
downloadsynapse-2a37467fa1358eb41513893efe44cbd294dca36c.tar.xz
Use google style doc strings.
pycharm supports them so there is no need to use the other format.

Might as well convert the existing strings to reduce the risk of
people accidentally cargo culting the wrong doc string format.
Diffstat (limited to 'synapse/storage/state.py')
-rw-r--r--synapse/storage/state.py13
1 files changed, 8 insertions, 5 deletions
diff --git a/synapse/storage/state.py b/synapse/storage/state.py
index 7fc9a4f264..f84fd0e30a 100644
--- a/synapse/storage/state.py
+++ b/synapse/storage/state.py
@@ -249,11 +249,14 @@ class StateStore(SQLBaseStore):
         """
         Get the state dict corresponding to a particular event
 
-        :param str event_id: event whose state should be returned
-        :param list[(str, str)]|None types: List of (type, state_key) tuples
-            which are used to filter the state fetched. May be None, which
-            matches any key
-        :return: a deferred dict from (type, state_key) -> state_event
+        Args:
+            event_id(str): event whose state should be returned
+            types(list[(str, str)]|None): List of (type, state_key) tuples
+                which are used to filter the state fetched. May be None, which
+                matches any key
+
+        Returns:
+            A deferred dict from (type, state_key) -> state_event
         """
         state_map = yield self.get_state_for_events([event_id], types)
         defer.returnValue(state_map[event_id])