Skip to content

Commit 00b6bbc

Browse files
committed
doc(sdk): Fix some typos in the documentation.
1 parent 88bceaf commit 00b6bbc

File tree

4 files changed

+11
-9
lines changed
  • crates
    • matrix-sdk/src/sliding_sync
    • matrix-sdk-base/src/sliding_sync
    • matrix-sdk-ui/src/room_list_service/sorters
  • testing/matrix-sdk-integration-testing/src

4 files changed

+11
-9
lines changed

crates/matrix-sdk-base/src/sliding_sync/http.rs

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
1-
// Copyright 2023 The Matrix.org Foundation C.I.C.
1+
// Copyright 2024 The Matrix.org Foundation C.I.C.
22
//
33
// Licensed under the Apache License, Version 2.0 (the "License");
44
// you may not use this file except in compliance with the License.
@@ -14,7 +14,7 @@
1414

1515
//! HTTP types for (Simplified) MSC3575.
1616
//!
17-
//! This module provides a unified namings for types from MSC3575 and
17+
//! This module provides unified namings for types from MSC3575 and
1818
//! Simplified MSC3575, in addition to provide conversion from one
1919
//! format to another.
2020

crates/matrix-sdk-ui/src/room_list_service/sorters/recency.rs

Lines changed: 4 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -64,8 +64,10 @@ where
6464
}
6565

6666
/// Create a new sorter that will sort two [`Room`] by recency, i.e. by
67-
/// comparing their [`matrix_sdk_base::RoomInfo::recency_stamp`] value. The
68-
/// `Room` with the newest recency stamp comes first, i.e. newest < oldest.
67+
/// comparing their [`RoomInfo::recency_stamp`] value. The `Room` with the
68+
/// newest recency stamp comes first, i.e. newest < oldest.
69+
///
70+
/// [`RoomInfo::recency_stamp`]: matrix_sdk_base::RoomInfo::recency_stamp
6971
pub fn new_sorter() -> impl Sorter {
7072
let matcher = RecencyMatcher {
7173
recency_stamps: move |left, right| (left.recency_stamp(), right.recency_stamp()),

crates/matrix-sdk/src/sliding_sync/cache.rs

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -495,7 +495,7 @@ mod tests {
495495
.await?
496496
.expect("must have restored sliding sync fields");
497497

498-
// After restoring, the delta token and to-device token could be read.
498+
// After restoring, to-device token could be read.
499499
assert_eq!(restored_fields.pos.unwrap(), pos);
500500

501501
// Test the "migration" path: assume a missing to-device token in crypto store,
@@ -530,8 +530,8 @@ mod tests {
530530
.await?
531531
.expect("must have restored fields");
532532

533-
// After restoring, the delta token, the to-device since token, stream
534-
// position and rooms could be read from the state store.
533+
// After restoring, the to-device since token, stream position and rooms could
534+
// be read from the state store.
535535
assert_eq!(restored_fields.to_device_token.unwrap(), to_device_token);
536536
assert_eq!(restored_fields.pos.unwrap(), pos);
537537
assert_eq!(restored_fields.rooms.len(), 1);

testing/matrix-sdk-integration-testing/src/helpers.rs

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -85,8 +85,8 @@ impl TestClientBuilder {
8585
.user_agent("matrix-sdk-integration-tests")
8686
.homeserver_url(homeserver_url)
8787
.sliding_sync_proxy(sliding_sync_proxy_url)
88-
// Disable Simplified MSC3575 for the integration tests as, at the time of writing, we
89-
// use a Synapse version that doesn't support Simplified MSC3575.
88+
// Disable Simplified MSC3575 for the integration tests as, at the time of writing
89+
// (2024-07-15), we use a Synapse version that doesn't support Simplified MSC3575.
9090
.simplified_sliding_sync(false)
9191
.with_encryption_settings(self.encryption_settings)
9292
.request_config(RequestConfig::short_retry());

0 commit comments

Comments
 (0)