update snapshot manager documentation

insightsengineering · Nov 13, 2023 · 54f05ba · 54f05ba
1 parent 2c928b2
commit 54f05ba
Show file tree

Hide file tree

Showing 2 changed files with 4 additions and 2 deletions.
diff --git a/R/module_snapshot_manager.R b/R/module_snapshot_manager.R
@@ -59,7 +59,8 @@
 #' which is disassembled for storage and used directly for restoring app state.
 #'
 #' @section Transferring snapshots:
-#' Snapshots uploaded from disk should only be used in the same application they come from.
+#' Snapshots uploaded from disk should only be used in the same application they come from,
+#' _i.e._ an application that uses the same data and the same modules.
 #' To ensure this is the case, `init` stamps `teal_slices` with an app id that is stored in the `app_id` attribute of
 #' a `teal_slices` object. When a snapshot is restored from file, its `app_id` is compared to that
 #' of the current app state and only if the match is the snapshot admitted to the session.

diff --git a/man/snapshot_manager_module.Rd b/man/snapshot_manager_module.Rd