File tree Expand file tree Collapse file tree 1 file changed +12
-5
lines changed
crates/matrix-sdk/src/room Expand file tree Collapse file tree 1 file changed +12
-5
lines changed Original file line number Diff line number Diff line change @@ -229,8 +229,12 @@ impl Joined {
229229 Ok ( ( ) )
230230 }
231231
232- /// Send a request to notify this room that the user has read specific
233- /// event.
232+ /// Send a request to set a read receipt, notifying this room that the user
233+ /// has read a specific event and *some* - but maybe not all - events before
234+ /// it.
235+ ///
236+ /// Use [`read_marker`][Self::read_marker] to indicate that the user has
237+ /// read a specific event and *every* message before it.
234238 ///
235239 /// # Arguments
236240 ///
@@ -247,12 +251,15 @@ impl Joined {
247251 Ok ( ( ) )
248252 }
249253
250- /// Send a request to notify this room that the user has read up to specific
251- /// event.
254+ /// Send a request to set a read marker, notifying this room that the user
255+ /// has read a specific event and *all* events before it.
256+ ///
257+ /// Use [`read_receipt`][Self::read_receipt] to indicate that the user has
258+ /// read a specific event and *some* - but maybe not all - events before it.
252259 ///
253260 /// # Arguments
254261 ///
255- /// * fully_read - The `EventId` of the event the user has read to .
262+ /// * fully_read - The `EventId` of the event to set the read marker on .
256263 ///
257264 /// * read_receipt - An `EventId` to specify the event to set the read
258265 /// receipt on.
You can’t perform that action at this time.
0 commit comments