Add a couple comments (#617)

As I'm trying to understand parts of the code
mitsuhiko · Sep 26, 2024 · afd4d20 · afd4d20
1 parent 0c239ca
commit afd4d20
Show file tree

Hide file tree

Showing 2 changed files with 2 additions and 2 deletions.
diff --git a/insta/src/env.rs b/insta/src/env.rs
@@ -480,7 +480,7 @@ impl std::str::FromStr for UnreferencedSnapshots {
     }
 }
 
-/// Memoizes a snapshot file in the reference file.
+/// Memoizes a snapshot file in the reference file, as part of removing unreferenced snapshots.
 pub fn memoize_snapshot_file(snapshot_file: &Path) {
     if let Ok(path) = env::var("INSTA_SNAPSHOT_REFERENCES_FILE") {
         let mut f = fs::OpenOptions::new()

diff --git a/insta/src/runtime.rs b/insta/src/runtime.rs
@@ -651,7 +651,7 @@ pub fn assert_snapshot(
     let new_snapshot =
         ctx.new_snapshot(SnapshotContents::new(new_snapshot_value.into(), kind), expr);
 
-    // memoize the snapshot file if requested.
+    // memoize the snapshot file if requested, as part of potentially removing unreferenced snapshots
     if let Some(ref snapshot_file) = ctx.snapshot_file {
         memoize_snapshot_file(snapshot_file);
     }