From 390a1aa12c7b461a2a7869e53e8876da7fa19d4d Mon Sep 17 00:00:00 2001 From: Denis Kasak Date: Thu, 9 Jul 2020 12:26:04 +0200 Subject: [PATCH] Clarify member_display_name docstring. --- matrix_sdk_base/src/models/room.rs | 6 ++++-- 1 file changed, 4 insertions(+), 2 deletions(-) diff --git a/matrix_sdk_base/src/models/room.rs b/matrix_sdk_base/src/models/room.rs index 41379b71..a96f5c84 100644 --- a/matrix_sdk_base/src/models/room.rs +++ b/matrix_sdk_base/src/models/room.rs @@ -321,8 +321,10 @@ impl Room { /// Get the disambiguated display name for a member of this room. /// - /// If a member has no display name set, returns the MXID as a fallback. Additionally, we - /// return the MXID even if there is no such member in the room. + /// If a member has no display name set, returns the MXID as a fallback. + /// + /// This method never fails, even if user with the supplied MXID is not a member in the room. + /// In this case we still return the supplied MXID as a fallback. /// /// When displaying a room member's display name, clients *must* use this method to obtain the /// name instead of displaying the `RoomMember::display_name` directly. This is because