(opendal) branch main updated: docs(core): Fix comment for into_futures_async_write (#4928)

[xu...@apache.org]

This is an automated email from the ASF dual-hosted git repository.

xuanwo pushed a commit to branch main
in repository https://gitbox.apache.org/repos/asf/opendal.git


The following commit(s) were added to refs/heads/main by this push:
     new fff8c74c38 docs(core): Fix comment for into_futures_async_write (#4928)
fff8c74c38 is described below

commit fff8c74c38d4816bce3088642ba919c69e8ee6d2
Author: Xuanwo <gi...@xuanwo.io>
AuthorDate: Fri Jul 26 16:16:35 2024 +0800

    docs(core): Fix comment for into_futures_async_write (#4928)
    
    Signed-off-by: Xuanwo <gi...@xuanwo.io>
---
 core/src/types/write/writer.rs | 5 ++---
 1 file changed, 2 insertions(+), 3 deletions(-)

diff --git a/core/src/types/write/writer.rs b/core/src/types/write/writer.rs
index 2562e88084..ca2f31ac6b 100644
--- a/core/src/types/write/writer.rs
+++ b/core/src/types/write/writer.rs
@@ -186,9 +186,8 @@ impl Writer {
     /// FuturesAsyncWriter is not a zero-cost abstraction. The underlying writer
     /// requires an owned [`Buffer`], which involves an extra copy operation.
     ///
-    /// FuturesAsyncWriters are automatically closed when they go out of scope. Errors detected on
-    /// closing are ignored by the implementation of Drop. Use the method `close` if these errors
-    /// must be manually handled.
+    /// FuturesAsyncWriter is required to call `close()` to make sure all
+    /// data have been written to the storage.
     ///
     /// # Examples
     ///