Fixup docstrings

This commit is contained in:
Erik Johnston 2019-04-02 11:15:19 +01:00
parent 39fb971e85
commit c75e2017f1
3 changed files with 9 additions and 7 deletions

View file

@ -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"]]

View file

@ -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)

View file

@ -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,