Skip to content

Commit f11b814

Browse files
authored
sdk: fix with_light_mode docs (#2700)
Signed-off-by: Mazdak Farrokhzad <[email protected]>
1 parent e32fc4a commit f11b814

File tree

1 file changed

+6
-4
lines changed

1 file changed

+6
-4
lines changed

crates/sdk/src/db_connection.rs

Lines changed: 6 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -926,10 +926,12 @@ but you must call one of them, or else the connection will never progress.
926926
/// Sets whether the "light" mode is used.
927927
///
928928
/// The light mode is meant for clients which are network-bandwidth constrained
929-
/// and results in the following:
930-
/// - Incremental updates will not include information about the reducer that caused them.
931-
/// - The client will not be notified about a reducer the client called
932-
/// without being subscribed to any relevant queries.
929+
/// and results in non-callers receiving only light incremental updates.
930+
/// These updates will not include information about the reducer that caused them,
931+
/// but will contain updates to subscribed-to tables.
932+
/// As a consequence, when light-mode is enabled,
933+
/// non-callers will not receive reducer callbacks,
934+
/// but will receive callbacks for row insertion/deletion/updates.
933935
pub fn with_light_mode(mut self, light: bool) -> Self {
934936
self.params.light = light;
935937
self

0 commit comments

Comments
 (0)