Skip to content

Commit 913ebe9

Browse files
committed
docs(redecryptor): Clarify that we're talking about the UI timeline in the r2d2 docs
1 parent 2e9e9ae commit 913ebe9

File tree

1 file changed

+7
-2
lines changed

1 file changed

+7
-2
lines changed

crates/matrix-sdk/src/event_cache/redecryptor.rs

Lines changed: 7 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -46,6 +46,10 @@
4646
//! received and R2D2 won't get notified about it. To work around this
4747
//! decryption requests can be explicitly sent to R2D2.
4848
//!
49+
//! In the graph bellow the Timeline block is meant to be the `Timeline` from
50+
//! the `matrix-sdk-ui` crate, but it could be any other listener that
51+
//! subscribes to [`RedecryptorReport`] stream.
52+
//!
4953
//! ```markdown
5054
//!
5155
//! .----------------------.
@@ -688,8 +692,9 @@ impl Redecryptor {
688692
// We missed some room keys, we need to report this in case a listener
689693
// has and idea which UTDs we should attempt to redecrypt.
690694
//
691-
// This would most likely be the timeline. The timeline might attempt
692-
// to redecrypt all UTDs it is showing to the user.
695+
// This would most likely be the timeline from the UI crate. The
696+
// timeline might attempt to redecrypt all UTDs it is showing to the
697+
// user.
693698
let Some(cache) = Self::upgrade_event_cache(cache) else {
694699
break false;
695700
};

0 commit comments

Comments
 (0)