[incubator-opendal] branch change-list-api updated: Polish docs

[xu...@apache.org]

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

xuanwo pushed a commit to branch change-list-api
in repository https://gitbox.apache.org/repos/asf/incubator-opendal.git


The following commit(s) were added to refs/heads/change-list-api by this push:
     new eaff8da60 Polish docs
eaff8da60 is described below

commit eaff8da60385bac6158799b7b9349a320a7b97e9
Author: Xuanwo <gi...@xuanwo.io>
AuthorDate: Sun Aug 6 11:55:16 2023 +0800

    Polish docs
    
    Signed-off-by: Xuanwo <gi...@xuanwo.io>
---
 core/src/docs/upgrade.md | 6 +++---
 1 file changed, 3 insertions(+), 3 deletions(-)

diff --git a/core/src/docs/upgrade.md b/core/src/docs/upgrade.md
index e37e057b5..2c837a82a 100644
--- a/core/src/docs/upgrade.md
+++ b/core/src/docs/upgrade.md
@@ -6,9 +6,9 @@
 
 RFC-2774 proposes a new `lister` API to replace current `list` and `scan`. And we add a new API `list` to return entries directly.
 
-For users who want to list a directory at once, please use `Operator::list` and `Operator::list_with` for convenience.
-
-For users who want to list a directory in streaming, please use `Operator::lister` and `Operator::lister_with` instead.
+- For listing a directory at once, please use `list()` for convenience.
+- For listing a directory recursively, please use `list_with().delimiter("")` or `lister_with().delimiter("")` instead.
+- For listing in streaming, please use `lister()` or `lister_with()` instead.
 
 # Upgrade to v0.39