diff --git a/synapse/handlers/profile.py b/synapse/handlers/profile.py
index 48f9858931..a9160c87e3 100644
--- a/synapse/handlers/profile.py
+++ b/synapse/handlers/profile.py
@@ -170,8 +170,8 @@ class ProfileHandler:
displayname_to_set = None
# If the admin changes the display name of a user, the requesting user cannot send
- # the join event to update the displayname in the rooms.
- # This must be done by the target user himself.
+ # the join event to update the display name in the rooms.
+ # This must be done by the target user themselves.
if by_admin:
requester = create_requester(
target_user,
diff --git a/synapse/rest/admin/users.py b/synapse/rest/admin/users.py
index 331f225116..932333ae57 100644
--- a/synapse/rest/admin/users.py
+++ b/synapse/rest/admin/users.py
@@ -336,7 +336,7 @@ class UserRestServletV2(RestServlet):
HTTPStatus.CONFLICT, "External id is already in use."
)
- if "avatar_url" in body and isinstance(body["avatar_url"], str):
+ if "avatar_url" in body:
await self.profile_handler.set_avatar_url(
target_user, requester, body["avatar_url"], True
)
diff --git a/synapse/storage/databases/main/profile.py b/synapse/storage/databases/main/profile.py
index b109f8c07f..c4022d2427 100644
--- a/synapse/storage/databases/main/profile.py
+++ b/synapse/storage/databases/main/profile.py
@@ -85,6 +85,14 @@ class ProfileWorkerStore(SQLBaseStore):
async def set_profile_displayname(
self, user_id: UserID, new_displayname: Optional[str]
) -> None:
+ """
+ Set the display name of a user.
+
+ Args:
+ user_id: The user's ID.
+ new_displayname: The new display name. If this is None, the user's display
+ name is removed.
+ """
user_localpart = user_id.localpart
await self.db_pool.simple_upsert(
table="profiles",
@@ -99,6 +107,14 @@ class ProfileWorkerStore(SQLBaseStore):
async def set_profile_avatar_url(
self, user_id: UserID, new_avatar_url: Optional[str]
) -> None:
+ """
+ Set the avatar of a user.
+
+ Args:
+ user_id: The user's ID.
+ new_avatar_url: The new avatar URL. If this is None, the user's avatar is
+ removed.
+ """
user_localpart = user_id.localpart
await self.db_pool.simple_upsert(
table="profiles",
diff --git a/synapse/util/msisdn.py b/synapse/util/msisdn.py
index 1046224f15..3721a1558e 100644
--- a/synapse/util/msisdn.py
+++ b/synapse/util/msisdn.py
@@ -22,12 +22,16 @@ def phone_number_to_msisdn(country: str, number: str) -> str:
Takes an ISO-3166-1 2 letter country code and phone number and
returns an msisdn representing the canonical version of that
phone number.
+
+ As an example, if `country` is "GB" and `number` is "7470674927", this
+ function will return "447470674927".
+
Args:
country: ISO-3166-1 2 letter country code
number: Phone number in a national or international format
Returns:
- The canonical form of the phone number, as an msisdn
+ The canonical form of the phone number, as an msisdn.
Raises:
SynapseError if the number could not be parsed.
"""
|
