summary refs log tree commit diff
diff options
context:
space:
mode:
authorErik Johnston <erik@matrix.org>2016-12-12 11:00:27 +0000
committerErik Johnston <erik@matrix.org>2016-12-12 11:00:27 +0000
commitd45c9846536bceb5f1bed09e0c67223481aa849b (patch)
treeea4642703e89ba5659a835ca8b982ddb23707ae6
parentComments (diff)
downloadsynapse-d45c9846536bceb5f1bed09e0c67223481aa849b.tar.xz
Docstring
-rw-r--r--synapse/storage/room.py12
1 files changed, 12 insertions, 0 deletions
diff --git a/synapse/storage/room.py b/synapse/storage/room.py
index 4b3605c776..277ccf2901 100644
--- a/synapse/storage/room.py
+++ b/synapse/storage/room.py
@@ -143,6 +143,18 @@ class RoomStore(SQLBaseStore):
     def set_room_is_public_appservice(self, room_id, appservice_id, network_id,
                                       is_public):
         """Edit the appservice/network specific public room list.
+
+        Each appservice can have a number of published room lists associated
+        with them, keyed off of an appservice defined `network_id`, which
+        basically represents a single instance of a bridge to a third party
+        network.
+
+        Args:
+            room_id (str)
+            appservice_id (str)
+            network_id (str)
+            is_public (bool): Whether to publish or unpublish the room from the
+                list.
         """
         def set_room_is_public_appservice_txn(txn, next_id):
             if is_public: