fs: update the doc comment of File::sync_data (#1596)

This commit is contained in:
Hung-I Wang 2019-09-26 00:05:50 +08:00 committed by Carl Lerche
parent c4567f741a
commit b71b7b36be

View File

@ -266,14 +266,14 @@ impl File {
asyncify(move || std.sync_all()).await asyncify(move || std.sync_all()).await
} }
/// This function is similar to `poll_sync_all`, except that it may not /// This function is similar to `sync_all`, except that it may not
/// synchronize file metadata to the filesystem. /// synchronize file metadata to the filesystem.
/// ///
/// This is intended for use cases that must synchronize content, but don't /// This is intended for use cases that must synchronize content, but don't
/// need the metadata on disk. The goal of this method is to reduce disk /// need the metadata on disk. The goal of this method is to reduce disk
/// operations. /// operations.
/// ///
/// Note that some platforms may simply implement this in terms of `poll_sync_all`. /// Note that some platforms may simply implement this in terms of `sync_all`.
/// ///
/// # Examples /// # Examples
/// ///