summary refs log tree commit diff
path: root/synapse/push/baserules.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/push/baserules.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/push/baserules.py')
-rw-r--r--synapse/push/baserules.py8
1 files changed, 5 insertions, 3 deletions
diff --git a/synapse/push/baserules.py b/synapse/push/baserules.py
index 792af70eb7..6add94beeb 100644
--- a/synapse/push/baserules.py
+++ b/synapse/push/baserules.py
@@ -19,9 +19,11 @@ import copy
 def list_with_base_rules(rawrules):
     """Combine the list of rules set by the user with the default push rules
 
-    :param list rawrules: The rules the user has modified or set.
-    :returns: A new list with the rules set by the user combined with the
-        defaults.
+    Args:
+        rawrules(list): The rules the user has modified or set.
+
+    Returns:
+        A new list with the rules set by the user combined with the defaults.
     """
     ruleslist = []