fix(storage): fix documentation of max_result parameter in list_blob #95
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
mf2199
reviewed
Jan 8, 2020
| (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. |
Collaborator
There was a problem hiding this comment.
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.
Collaborator
Author
There was a problem hiding this comment.
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.
MaxxleLLC
force-pushed
the
storage_doc_fix_list_blob
branch
from
848b1bf to
1c0ab69
Compare
|
@HemangChothani Thanks for picking this up, changing the docs here should be sufficient to resolve https://github.com/googleapis/google-cloud-python/issues/10030 I think. |
This reverts commit 1c0ab69.
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
IPR 10030