summary refs log tree commit diff
path: root/synapse
diff options
context:
space:
mode:
authorErik Johnston <erik@matrix.org>2019-04-02 11:15:19 +0100
committerErik Johnston <erik@matrix.org>2019-04-02 11:20:06 +0100
commitc75e2017f16bf18127f4f70f69100b8343a139c4 (patch)
tree4e85259a4db02600aee024ad22b73d1aee05cc57 /synapse
parentNewsfile (diff)
downloadsynapse-c75e2017f16bf18127f4f70f69100b8343a139c4.tar.xz
Fixup docstrings
Diffstat (limited to 'synapse')
-rw-r--r--synapse/handlers/identity.py6
-rw-r--r--synapse/storage/registration.py6
-rw-r--r--synapse/storage/schema/delta/53/user_threepid_id.sql4
3 files changed, 9 insertions, 7 deletions
diff --git a/synapse/handlers/identity.py b/synapse/handlers/identity.py
index 4c127ba125..3eb112bf9d 100644
--- a/synapse/handlers/identity.py
+++ b/synapse/handlers/identity.py
@@ -150,14 +150,16 @@ class IdentityHandler(BaseHandler):
 
         Args:
             mxid (str): Matrix user ID of binding to be removed
-            threepid (dict): Dict with medium & address of binding to be removed
+            threepid (dict): Dict with medium & address of binding to be
+                removed, and an optional id_server.
 
         Raises:
             SynapseError: If we failed to contact the identity server
 
         Returns:
             Deferred[bool]: True on success, otherwise False if the identity
-            server doesn't support unbinding
+            server doesn't support unbinding (or no identity server found to
+            contact).
         """
         if threepid.get("id_server"):
             id_servers = [threepid["id_server"]]
diff --git a/synapse/storage/registration.py b/synapse/storage/registration.py
index 4d64107e16..8ada655725 100644
--- a/synapse/storage/registration.py
+++ b/synapse/storage/registration.py
@@ -358,9 +358,9 @@ class RegistrationWorkerStore(SQLBaseStore):
         )
 
     def remove_user_bound_threepid(self, user_id, medium, address, id_server):
-        """The server proxied a bind request to the given identity server on
-        behalf of the given user. We need to remember this in case the user
-        asks us to unbind the threepid.
+        """The server proxied an unbind request to the given identity server on
+        behalf of the given user, so we remove the mapping of threepid to
+        identity server.
 
         Args:
             user_id (str)
diff --git a/synapse/storage/schema/delta/53/user_threepid_id.sql b/synapse/storage/schema/delta/53/user_threepid_id.sql
index 6c0b7ec0f7..80c2c573b6 100644
--- a/synapse/storage/schema/delta/53/user_threepid_id.sql
+++ b/synapse/storage/schema/delta/53/user_threepid_id.sql
@@ -13,8 +13,8 @@
  * limitations under the License.
  */
 
--- Tracks when
-CREATE TABlE user_threepid_id_server (
+-- Tracks which identity server a user bound their threepid via.
+CREATE TABLE user_threepid_id_server (
     user_id TEXT NOT NULL,
     medium TEXT NOT NULL,
     address TEXT NOT NULL,