doc(crypto) Update a doc comment on update_user_state_to

andybalaam · bnjbvr · commit d3d7c03892e0 · 2024-10-25T14:27:06.000+02:00
diff --git 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<R: RoomIdentityProvider> RoomIdentityState<R> {
         }
     }
 
-    // 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,

Original file line number	Diff line number	Diff line change
`@@ -192,9 +192,10 @@ impl<R: RoomIdentityProvider> RoomIdentityState<R> {`
`192`	`192`	`}`
`193`	`193`	`}`
`194`	`194`
`195`		- // If the supplied `new_state` represents an actual change, updates our internal
`196`		`- // state for this user, and returns the change information we will surface to`
`197`		`- // the UI.`
	`195`	+ /// Updates our internal state for this user to the supplied `new_state`. If
	`196`	`+ /// the change of state is significant (it requires something to change`
	`197`	`+ /// in the UI, like a warning being added or removed), returns the`
	`198`	`+ /// change information we will surface to the UI.`
`198`	`199`	`fn update_user_state_to(`
`199`	`200`	`&mut self,`
`200`	`201`	`user_id: &UserId,`