Add comment

quambene · Jan 30, 2024 · b980594 · b980594
1 parent e924a2b
commit b980594
Showing 1 changed file with 2 additions and 0 deletions.
diff --git a/src/utils.rs b/src/utils.rs
@@ -168,6 +168,8 @@ pub async fn remove_file_async(path: &Path) -> Result<(), BogrepError> {
 }
 
 /// Helper function to close and rename a file.
+///
+/// Closing the file before renaming it is needed on Windows.
 pub fn close_and_rename(from: (File, &Path), to: (File, &Path)) -> Result<(), BogrepError> {
     debug!("Close file at {}", from.1.display());
     drop(from.0);