Skip to content

Commit 5880719

Browse files
authored
Docs/fixit: normalize docs for 'page_size' / 'max_results' / 'page_token' (#6842)
1 parent b0f2183 commit 5880719

2 files changed

Lines changed: 17 additions & 8 deletions

File tree

packages/google-cloud-storage/google/cloud/storage/bucket.py

Lines changed: 10 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -623,12 +623,18 @@ def list_blobs(
623623
If :attr:`user_project` is set, bills the API request to that project.
624624
625625
:type max_results: int
626-
:param max_results: (Optional) Maximum number of blobs to return.
626+
:param max_results:
627+
(Optional) The maximum number of blobs in each page of results
628+
from this request. Non-positive values are ignored. Defaults to
629+
a sensible value set by the API.
627630
628631
:type page_token: str
629-
:param page_token: (Optional) Opaque marker for the next "page" of
630-
blobs. If not passed, will return the first page
631-
of blobs.
632+
:param page_token:
633+
(Optional) If present, return the next batch of blobs, using the
634+
value, which must correspond to the ``nextPageToken`` value
635+
returned in the previous response. Deprecated: use the ``pages``
636+
property of the returned iterator instead of manually passing the
637+
token.
632638
633639
:type prefix: str
634640
:param prefix: (Optional) prefix used to filter blobs.

packages/google-cloud-storage/google/cloud/storage/client.py

Lines changed: 7 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -308,12 +308,15 @@ def list_buckets(
308308
This implements "storage.buckets.list".
309309
310310
:type max_results: int
311-
:param max_results: Optional. Maximum number of buckets to return.
311+
:param max_results: Optional. The maximum number of buckets to return.
312312
313313
:type page_token: str
314-
:param page_token: Optional. Opaque marker for the next "page" of
315-
buckets. If not passed, will return the first page
316-
of buckets.
314+
:param page_token:
315+
Optional. If present, return the next batch of buckets, using the
316+
value, which must correspond to the ``nextPageToken`` value
317+
returned in the previous response. Deprecated: use the ``pages``
318+
property of the returned iterator instead of manually passing the
319+
token.
317320
318321
:type prefix: str
319322
:param prefix: Optional. Filter results to buckets whose names begin

0 commit comments

Comments
 (0)