suyanhanx commented on code in PR #2787:
URL:
https://github.com/apache/incubator-opendal/pull/2787#discussion_r1285149523
##########
core/src/docs/upgrade.md:
##########
@@ -1,3 +1,15 @@
+# Unreleased
+
+## Public API
+
+### RFC-2774 Lister API
+
+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 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.
Review Comment:
Please also update here for `scan`.
--
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
To unsubscribe, e-mail: commits-unsubscr...@opendal.apache.org
For queries about this service, please contact Infrastructure at:
us...@infra.apache.org
