Skip to content

Fix: correct typos and grammar in README #16535

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

Open
Mr-Documents wants to merge 3 commits into
base: main
Choose a base branch
from
+14 −17
Open

Fix: correct typos and grammar in README #16535

Changes from 2 commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
9947c55
Fix typos and improve wording in README.rst
Mr-Documents Apr 2, 2026
38180dc
Merge branch 'googleapis:main' into main
Mr-Documents Apr 2, 2026
46d2523
fix: restore inline link and capitalization of None in README.
Mr-Documents Apr 2, 2026
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
28 changes: 13 additions & 15 deletions packages/google-cloud-storage/README.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@ Python Client for Google Cloud Storage
|stable| |pypi| |versions|

`Google Cloud Storage`_ is a managed service for storing unstructured data. Cloud Storage
allows world-wide storage and retrieval of any amount of data at any time. You can use
allows worldwide storage and retrieval of any amount of data at any time. You can use
Cloud Storage for a range of scenarios including serving website content, storing data
for archival and disaster recovery, or distributing large data objects to users via direct download.

Expand Down Expand Up @@ -43,13 +43,13 @@ Google APIs Client Libraries, in `Client Libraries Explained`_.
Quick Start
-----------

In order to use this library, you first need to go through the following steps.
To use this library, you first need to follow these steps.
A step-by-step guide may also be found in `Get Started with Client Libraries`_.

1. `Select or create a Cloud Platform project.`_
2. `Enable billing for your project.`_
3. `Enable the Google Cloud Storage API.`_
4. `Setup Authentication.`_
4. `Set up Authentication.`_

.. _Get Started with Client Libraries: https://cloud.google.com/storage/docs/reference/libraries#client-libraries-install-python
.. _Select or create a Cloud Platform project.: https://console.cloud.google.com/project
Expand Down Expand Up @@ -145,15 +145,15 @@ Tracing With OpenTelemetry
This is a PREVIEW FEATURE: Coverage and functionality are still in development and subject to change.

This library can be configured to use `OpenTelemetry`_ to generate traces on calls to Google Cloud Storage.
For information on the benefits and utility of tracing, read the `Cloud Trace Overview <https://cloud.google.com/trace/docs/overview>`_.
For information on the benefits and utility of tracing, read the `Cloud Trace Overview`_.
Copy link
Copy Markdown
Contributor

@gemini-code-assist gemini-code-assist Bot Apr 2, 2026

Choose a reason for hiding this comment

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

medium

The change to a reference link (Cloud Trace Overview_) will likely break the link if the corresponding reference definition is not added to the document. Additionally, if the reference name contains spaces, it must be enclosed in backticks (e.g., `Cloud Trace Overview`_) to be recognized as a single reference. It is recommended to revert to the inline link format to ensure the link remains functional.

Suggested change
For information on the benefits and utility of tracing, read the `Cloud Trace Overview`_.
For information on the benefits and utility of tracing, read the Cloud Trace Overview <https://cloud.google.com/trace/docs/overview>_.


To enable OpenTelemetry tracing in the Cloud Storage client, first install OpenTelemetry:

.. code-block:: console

pip install google-cloud-storage[tracing]

Set the ``ENABLE_GCS_PYTHON_CLIENT_OTEL_TRACES`` environment variable to selectively opt-in tracing for the Cloud Storage client:
Set the ``ENABLE_GCS_PYTHON_CLIENT_OTEL_TRACES`` environment variable to opt in selectively to tracing for the Cloud Storage client:

.. code-block:: console

Expand Down Expand Up @@ -199,8 +199,8 @@ For a list of libraries that can be instrumented, refer to the `OpenTelemetry Re
Feedback Welcome
~~~~~~~~~~~~~~~~

If you experience that backwards compatibility for your application is broken
with this major version release, please let us know through the Github issues
If you experience any break in backwards compatibility for your application
with this major version release, please let us know through the GitHub issues
system. While some breaks of backwards compatibility may be unavoidable due to
new features in the major version release, we will do our best to minimize
them. Thank you.
Expand All @@ -226,7 +226,7 @@ Some users may be using the original exception classes from the
``google-resumable-media`` library without explicitly installing that library. So
as not to break user applications following this pattern,
``google-resumable-media`` is still in the list of dependencies in this package's
setup.py file. Applications which do not import directly from
setup.py file. Applications that do not import directly from
``google-resumable-media`` can safely disregard this dependency.
This backwards compatibility feature **will be removed** in a future major
version update. Please migrate to using the ``google.cloud.storage.exceptions``
Expand All @@ -239,12 +239,11 @@ In Python Storage 3.0, uploads and downloads now have a default of "auto" where
applicable. "Auto" will use crc32c checksums, except for unusual cases where the
fast (C extension) crc32c implementation is not available, in which case it will
use md5 instead. Before Python Storage 3.0, the default was md5 for most
downloads and None for most uploads. Note that ranged downloads ("start" or
"end" set) still do not support any checksumming, and some features in
downloads and none for most uploads. Note that ranged downloads ("start" or "end" set) still do not support any checksumming, and some features in
Copy link
Copy Markdown
Contributor

@gemini-code-assist gemini-code-assist Bot Apr 2, 2026

Choose a reason for hiding this comment

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

medium

In the context of Python libraries, None refers to the specific Python singleton. Changing it to lowercase none is inconsistent with line 246 and may be less clear to users. It is better to keep it capitalized when referring to the technical default value.

Suggested change
downloads and none for most uploads. Note that ranged downloads ("start" or "end" set) still do not support any checksumming, and some features in
downloads and None for most uploads. Note that ranged downloads ("start" or "end" set) still do not support any checksumming, and some features in

``transfer_manager.py`` still support crc32c only.

Note: The method ``Blob.upload_from_file()`` requires a file in bytes mode, but
when checksum is set to None, as was the previous default, would not throw an
when checksum is set to None, as was the previous default, it would not throw an
error if passed a file in string mode under some circumstances. With the new
defaults, it will now raise a TypeError. Please use a file opened in bytes
reading mode as required.
Expand All @@ -255,13 +254,12 @@ Miscellaneous
- The ``BlobWriter`` class now attempts to terminate an ongoing resumable upload if
the writer exits with an exception.
- Retry behavior is now identical between media operations (uploads and
downloads) and other operations, and custom predicates are now supported for
media operations as well.
downloads) and other operations, and custom predicates are now supported
for media operations as well.
- ``Blob.download_as_filename()`` will now delete the empty file if it results in a
google.cloud.exceptions.NotFound exception (HTTP 404).
- Previously, object upload, metadata update, and delete methods had retries
disabled by default unless the generation or metageneration was specified in
the request. This has now changed so that retries are enabled by default.
disabled by default unless the generation or metageneration was specified in the request. This has now changed so that retries are enabled by default.


Next Steps
Expand Down
Loading