summary refs log tree commit diff
path: root/synapse
diff options
context:
space:
mode:
authorLuke Barnard <luke@matrix.org>2018-04-05 13:29:16 +0100
committerLuke Barnard <luke@matrix.org>2018-04-05 13:29:16 +0100
commitb214a04ffc1200535f1d9c6ec45717cd266f36e5 (patch)
tree7fbd53a358284c2c3cf89bd1e8c3861f1ba193a7 /synapse
parentUse join_policy API instead of joinable (diff)
downloadsynapse-b214a04ffc1200535f1d9c6ec45717cd266f36e5.tar.xz
Document set_group_join_policy
Diffstat (limited to 'synapse')
-rw-r--r--synapse/storage/group_server.py6
1 files changed, 6 insertions, 0 deletions
diff --git a/synapse/storage/group_server.py b/synapse/storage/group_server.py
index db66ea1eb0..ab4f710f7d 100644
--- a/synapse/storage/group_server.py
+++ b/synapse/storage/group_server.py
@@ -31,6 +31,12 @@ _DEFAULT_ROLE_ID = ""
 
 class GroupServerStore(SQLBaseStore):
     def set_group_join_policy(self, group_id, join_policy):
+        """Set the join policy of a group.
+
+        join_policy can be one of:
+         * "invite"
+         * "open"
+        """
         return self._simple_update_one(
             table="groups",
             keyvalues={