char
/
matrix-rust-sdk
1
0
Fork 0
Code Issues Pull Requests Projects Releases Wiki Activity

Clarify member_display_name docstring.

master
Denis Kasak 2020-07-09 12:26:04 +02:00
parent b16724841d
commit 390a1aa12c
1 changed files with 4 additions and 2 deletions
Show Stats 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. /// 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 /// If a member has no display name set, returns the MXID as a fallback.
/// return the MXID even if there is no such member in the room. ///
/// 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 /// 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 /// name instead of displaying the `RoomMember::display_name` directly. This is because