doc: document how to "keep" temporary files/dirs after creation (#328)

fixes #315
Stebalien · Feb 16, 2025 · 0fe11c4 · 0fe11c4
1 parent 35e0629
commit 0fe11c4
Showing 1 changed file with 4 additions and 1 deletion.
diff --git a/src/lib.rs b/src/lib.rs
@@ -466,7 +466,10 @@ impl<'a, 'b> Builder<'a, 'b> {
     /// scope.
     ///
     /// By default, the file/folder is automatically cleaned up in the destructor of
-    /// [`NamedTempFile`]/[`TempDir`]. When `keep` is set to `true`, this behavior is supressed.
+    /// [`NamedTempFile`]/[`TempDir`]. When `keep` is set to `true`, this behavior is suppressed.
+    ///
+    /// If you wish to keep a temporary file or directory after creating it, call
+    /// [`NamedTempFile::keep`] or [`TempDir::into_path`] respectively.
     ///
     /// # Examples
     ///