You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@opendal.apache.org by xu...@apache.org on 2024/07/26 05:03:34 UTC

(opendal) 01/01: docs(core): Fix comment for into_futures_async_write

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

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

commit 6a8616e9918be1ccea10791da7d80efeacf92948
Author: Xuanwo <gi...@xuanwo.io>
AuthorDate: Fri Jul 26 13:03:13 2024 +0800

    docs(core): Fix comment for into_futures_async_write
    
    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
     ///