Fix: correct typos and grammar in README#16535
Fix: correct typos and grammar in README#16535Mr-Documents wants to merge 3 commits intogoogleapis:mainfrom
Conversation
fix: correct typos and grammar in README.
![gemini-code-assist[bot]](https://avatars.githubusercontent.com/in/956858?s=60&v=4){kind=small}
There was a problem hiding this comment.
Code Review
This pull request performs various documentation updates and stylistic improvements to the README.rst file, such as correcting spelling, improving grammar, and reformatting text for clarity. Review feedback highlights a potential broken link caused by switching to a reference format without a corresponding definition and recommends keeping 'None' capitalized when referring to the Python singleton to maintain consistency and technical accuracy.
|
|
||
| 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`_. |
There was a problem hiding this comment.
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.
| 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>_. |
| 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 |
There was a problem hiding this comment.
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.
| 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 |
1 participant
Corrected minor typos and improved readability in README.rst. No functional changes.