Skip to content
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.

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

Storage: download_as_string documentation says that it downloads a string, instead of bytes #9290

Closed
olsgaard opened this issue Sep 25, 2019 · 2 comments · Fixed by #9332
Closed
Assignees
Labels
api: storage Issues related to the Cloud Storage API. type: docs Improvement to the documentation for an API.

Comments

@olsgaard
Copy link

For google-cloud-storage, in the documentation for download_as_string() method on blobs, it says on line 715:

    """Download the contents of this blob as a string.

This is not true. The confusingly named method downloads the content as bytes, not string.

On line 731, the return type is correctly declared as bytes, but reading the documentation, you are still presented with conflicting information.

@HemangChothani HemangChothani added api: storage Issues related to the Cloud Storage API. type: docs Improvement to the documentation for an API. labels Sep 25, 2019
@HemangChothani
Copy link
Contributor

@tseaver is it ok to change method's name ,Please suggest.

@busunkim96 busunkim96 assigned crwilcox and unassigned crwilcox Sep 25, 2019
@busunkim96 busunkim96 changed the title download_as_string documentation says that it downloads a string, instead of bytes Storage: download_as_string documentation says that it downloads a string, instead of bytes Sep 25, 2019
@tseaver
Copy link
Contributor

tseaver commented Sep 25, 2019

@HemangChothani We cannot change the method's name: that would be a breaking change. Note that we chose that method name explicitly for compatibility with the API of the AWS / S3 boto library.

We can update its docstring to indicate its actual semantics.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
api: storage Issues related to the Cloud Storage API. type: docs Improvement to the documentation for an API.
Projects
None yet
4 participants