base: Fix a stale docstring.

master
Damir Jelić 2020-08-12 17:17:56 +02:00
parent 7ee0430054
commit c6b0a19171
1 changed files with 5 additions and 2 deletions

View File

@ -703,8 +703,11 @@ impl BaseClient {
/// Receive a timeline event for a joined room and update the client state.
///
/// Returns a tuple of the successfully decrypted event, or None on failure and
/// a bool, true when the `Room` state has been updated.
/// Returns a bool, true when the `Room` state has been updated.
///
/// This will in-place replace the event with a decrypted one if the
/// encryption feature is turned on, the event is encrypted and if we
/// successfully decrypted the event.
///
/// # Arguments
///