Fix docstrings regarding return value related to disambiguation.

master
Denis Kasak 2020-07-15 11:54:30 +02:00
parent 8a4a4140b3
commit 1fd21ee206
1 changed files with 8 additions and 8 deletions

View File

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