Skip to content

fix(storage): fix documentation of max_result parameter in list_blob #95

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Draft
HemangChothani wants to merge 3 commits into
base: master
Choose a base branch
from
Draft

fix(storage): fix documentation of max_result parameter in list_blob #95

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
0ffca67
fix(storage): fix documentation of max_result parameter in list_blob …
HemangChothani Jan 3, 2020
1c0ab69
fix(storage): description changes
HemangChothani Jan 8, 2020
2573a80
Revert "fix(storage): description changes"
HemangChothani Jan 9, 2020
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
4 changes: 1 addition & 3 deletions storage/google/cloud/storage/bucket.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -885,9 +885,7 @@ def list_blobs(

:type max_results: int
:param max_results:
(Optional) The maximum number of blobs in each page of results
from this request. Non-positive values are ignored. Defaults to
a sensible value set by the API.
(Optional) The maximum number of blobs to return.
Copy link
Collaborator

@mf2199 mf2199 Jan 8, 2020

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I'd rather minimize the changes:

                (Optional) The maximum total number of blobs in results
                from this request. Non-positive values are ignored. Defaults to
                a sensible value set by the API.

The last sentence can possibly be removed if the default value does not exist.

Copy link
Collaborator Author

@HemangChothani HemangChothani Jan 8, 2020 •
edited
Loading

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

@mf2199 I have copied the discription from other page like here to maintain the consistency, if needed i will change it.

Copy link

@bz2 bz2 Jan 8, 2020

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I don't think "Non-positive values are ignored." is actually true from the implementation. None is ignored/header is not set so default applies, and 0 and negative numbers are equivalent and will result in an empty iterator.


:type page_token: str
:param page_token:
Expand Down
4 changes: 1 addition & 3 deletions storage/google/cloud/storage/client.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -508,9 +508,7 @@ def list_blobs(
The bucket resource to pass or name to create.

max_results (int):
(Optional) The maximum number of blobs in each page of results
from this request. Non-positive values are ignored. Defaults to
a sensible value set by the API.
(Optional) The maximum number of blobs to return.

page_token (str):
(Optional) If present, return the next batch of blobs, using the
Expand Down