Skip to content

Commit 34bcd6d

Browse files
committed
doc(sdk): Fix some typos in the documentation.
1 parent da579f6 commit 34bcd6d

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
@@ -522,7 +522,7 @@ mod tests {
522522
.await?
523523
.expect("must have restored sliding sync fields");
524524

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

528528
// Test the "migration" path: assume a missing to-device token in crypto store,
@@ -557,8 +557,8 @@ mod tests {
557557
.await?
558558
.expect("must have restored fields");
559559

560-
// After restoring, the delta token, the to-device since token, stream
561-
// position and rooms could be read from the state store.
560+
// After restoring, the to-device since token, stream position and rooms could
561+
// be read from the state store.
562562
assert_eq!(restored_fields.to_device_token.unwrap(), to_device_token);
563563
assert_eq!(restored_fields.pos.unwrap(), pos);
564564
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
@@ -88,8 +88,8 @@ impl TestClientBuilder {
8888
.user_agent("matrix-sdk-integration-tests")
8989
.homeserver_url(homeserver_url)
9090
.sliding_sync_proxy(sliding_sync_proxy_url)
91-
// Disable Simplified MSC3575 for the integration tests as, at the time of writing, we
92-
// use a Synapse version that doesn't support Simplified MSC3575.
91+
// Disable Simplified MSC3575 for the integration tests as, at the time of writing
92+
// (2024-07-15), we use a Synapse version that doesn't support Simplified MSC3575.
9393
.simplified_sliding_sync(false)
9494
.with_encryption_settings(self.encryption_settings)
9595
.request_config(RequestConfig::short_retry());

0 commit comments

Comments
 (0)