Fix docstrings regarding return value related to disambiguation.

This commit is contained in:
Denis Kasak 2020-07-15 11:54:30 +02:00
parent 8a4a4140b3
commit 1fd21ee206

View file

@ -342,8 +342,8 @@ impl Room {
/// Returns a tuple of:
///
/// 1. True if the event made changes to the room's state, false otherwise.
/// 2. Returns a map of display name disambiguations which tells us which
/// members need to have their display names disambiguated and to what.
/// 2. A map of display name ambiguity status changes (see
/// `disambiguation_updates`).
///
/// # Arguments
///
@ -396,8 +396,8 @@ impl Room {
/// Returns a tuple of:
///
/// 1. True if the event made changes to the room's state, false otherwise.
/// 2. Returns a map of display name disambiguations which tells us which
/// members need to have their display names disambiguated and to what.
/// 2. A map of display name ambiguity status changes (see
/// `disambiguation_updates`).
///
/// # Arguments
///
@ -605,8 +605,8 @@ impl Room {
/// Returns a tuple of:
///
/// 1. True if the joined member list changed, false otherwise.
/// 2. A map of display name disambiguations which tells us which members
/// need to have their display names disambiguated and to what.
/// 2. A map of display name ambiguity status changes (see
/// `disambiguation_updates`).
pub fn handle_membership(
&mut self,
event: &StateEventStub<MemberEventContent>,
@ -913,8 +913,8 @@ impl Room {
/// Returns a tuple of:
///
/// 1. True if the event made changes to the room's state, false otherwise.
/// 2. A map of display name disambiguations which tells us which members
/// need to have their display names disambiguated and to what.
/// 2. A map of display name ambiguity status changes (see
/// `disambiguation_updates`).
///
/// # Arguments
///