File: Add documentation about dropping to sync_all

1 files changed, 5 insertions, 1 deletions

diff --git a/src/libstd/fs.rs b/src/libstd/fs.rs
index 034564250c3..c0d4dfc8927 100644
--- a/src/libstd/fs.rs
+++ b/src/libstd/fs.rs
@@ -394,9 +394,13 @@ impl File {
 
     /// Attempts to sync all OS-internal metadata to disk.
     ///
-    /// This function will attempt to ensure that all in-core data reaches the
+    /// This function will attempt to ensure that all in-memory data reaches the
     /// filesystem before returning.
     ///
+    /// This can be used to handle errors that would otherwise only be caught
+    /// when the `File` is closed.  Dropping a file will ignore errors in
+    /// synchronizing this in-memory data.
+    ///
     /// # Examples
     ///
     /// ```no_run