address review comments

minio · Dec 4, 2020 · 86e9094 · 86e9094
1 parent 53a2a87
commit 86e9094
Show file tree

Hide file tree

Showing 2 changed files with 16 additions and 10 deletions.
diff --git a/docs/API.md b/docs/API.md
@@ -132,9 +132,9 @@ List information of all accessible buckets.
 
 __Parameters__
 
-| Return                                   |
-|:-----------------------------------------|
-| An iterator contains bucket information. |
+| Return           |
+|:-----------------|
+| List of _Bucket_ |
 
 __Example__
 
@@ -185,9 +185,9 @@ client.remove_bucket("my-bucket")
 
 <a name="list_objects"></a>
 
-### list_objects(bucket_name, prefix=None, recursive=False, include_version=False)
+### list_objects(bucket_name, prefix=None, recursive=False, start_after=None, include_user_meta=False, include_version=False, use_api_v1=False)
 
-Lists object information of a bucket using S3 API version 1, optionally for prefix recursively.
+Lists object information of a bucket.
 
 __Parameters__
 
@@ -203,9 +203,9 @@ __Parameters__
 
 __Return Value__
 
-| Return                                                    |
-|:----------------------------------------------------------|
-| An iterator contains object information as _minio.Object_ |
+| Return                  |
+|:------------------------|
+| An iterator of _Object_ |
 
 __Example__
 
@@ -437,6 +437,12 @@ __Parameters__
 | `suffix`      | _str_  | Listen events of object ends with suffix.   |
 | `events`      | _list_ | Events to listen.                           |
 
+__Return Value__
+
+| Param                               |
+|:------------------------------------|
+| Iterator of event records as _dict_ |
+
 ```py
 events = client.listen_bucket_notification(
     "my-bucket",

diff --git a/minio/api.py b/minio/api.py
@@ -863,7 +863,7 @@ def listen_bucket_notification(self, bucket_name, prefix='', suffix='',
         :param prefix: Listen events of object starts with prefix.
         :param suffix: Listen events of object ends with suffix.
         :param events: Events to listen.
-        :return: Iterator contains event records.
+        :return: Iterator of event records as :dict:.
 
         Example::
             events = client.listen_bucket_notification(
@@ -1806,7 +1806,7 @@ def list_objects(self, bucket_name, prefix=None, recursive=False,
         :param include_version: Flag to control whether include object
                                 versions.
         :param use_api_v1: Flag to control to use ListObjectV1 S3 API or not.
-        :return: An iterator contains object information.
+        :return: Iterator of :class:`Object <Object>`.
 
         Example::
             # List objects information.