From dec4b2122b2bc843d596862d83317bcabb39aa0f Mon Sep 17 00:00:00 2001 From: Ivan Enderlin Date: Wed, 22 Feb 2023 16:51:42 +0100 Subject: [PATCH] doc(sdk): Improve documentation of `SlidingSyncMode`. --- crates/matrix-sdk/src/sliding_sync/mod.rs | 8 +++++--- 1 file changed, 5 insertions(+), 3 deletions(-) diff --git a/crates/matrix-sdk/src/sliding_sync/mod.rs b/crates/matrix-sdk/src/sliding_sync/mod.rs index a35f0989f..418b834cc 100644 --- a/crates/matrix-sdk/src/sliding_sync/mod.rs +++ b/crates/matrix-sdk/src/sliding_sync/mod.rs @@ -690,11 +690,13 @@ pub enum SlidingSyncState { /// The mode by which the the [`SlidingSyncView`] is in fetching the data. #[derive(Debug, Default, Clone, PartialEq, Eq, Serialize, Deserialize)] pub enum SlidingSyncMode { - /// fully sync all rooms in the background, page by page of `batch_size` + /// Fully sync all rooms in the background, page by page of `batch_size`, + /// like `0..20`, `21..40`, 41..60` etc. assuming the `batch_size` is 20. #[serde(alias = "FullSync")] PagingFullSync, - /// fully sync all rooms in the background, with a growing window of - /// `batch_size`, + /// Fully sync all rooms in the background, with a growing window of + /// `batch_size`, like `0..20`, `0..40`, `0..60` etc. assuming the + /// `batch_size` is 20. GrowingFullSync, /// Only sync the specific windows defined #[default]