mirror/matrix-rust-sdk
1
0
Fork 0
mirror of https://github.com/matrix-org/matrix-rust-sdk.git synced 2026-05-19 14:19:06 -04:00
Code Issues Packages Projects Releases Wiki Activity

Clarify member_display_name docstring.

Browse Source
This commit is contained in:
Denis Kasak
2020-07-09 12:26:04 +02:00
parent b16724841d
commit 390a1aa12c
1 changed files with 4 additions and 2 deletions
Download Patch File Download Diff File Expand all files Collapse all files

6
matrix_sdk_base/src/models/room.rs
View File

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