From d3d7c03892e007615643ebaa9cfb51b772ef89f7 Mon Sep 17 00:00:00 2001 From: Andy Balaam Date: Fri, 25 Oct 2024 10:43:07 +0100 Subject: [PATCH] doc(crypto) Update a doc comment on update_user_state_to --- .../src/identities/room_identity_state.rs | 7 ++++--- 1 file changed, 4 insertions(+), 3 deletions(-) diff --git a/crates/matrix-sdk-crypto/src/identities/room_identity_state.rs b/crates/matrix-sdk-crypto/src/identities/room_identity_state.rs index d4aa4817a..4e07887c7 100644 --- a/crates/matrix-sdk-crypto/src/identities/room_identity_state.rs +++ b/crates/matrix-sdk-crypto/src/identities/room_identity_state.rs @@ -192,9 +192,10 @@ impl RoomIdentityState { } } - // If the supplied `new_state` represents an actual change, updates our internal - // state for this user, and returns the change information we will surface to - // the UI. + /// Updates our internal state for this user to the supplied `new_state`. If + /// the change of state is significant (it requires something to change + /// in the UI, like a warning being added or removed), returns the + /// change information we will surface to the UI. fn update_user_state_to( &mut self, user_id: &UserId,