-
Notifications
You must be signed in to change notification settings - Fork 260
[Backport to 4.0] - Update documentation in configuration.md file (#1606) #1614
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
Conversation
Summary of ChangesHello @shrutisinghania, I'm Gemini Code Assist1! I'm currently reviewing this pull request and will post my feedback shortly. In the meantime, here's a summary to help you and other reviewers quickly get up to speed! This pull request enhances the documentation for Google Cloud Storage (GCS) connector configuration properties. The primary goal is to provide clearer and more precise information regarding the applicability and behavior of various settings, especially when switching between the Highlights
🧠 New Feature in Public Preview: You can now enable Memory to help Gemini Code Assist learn from your team's feedback. This makes future code reviews more consistent and personalized to your project's style. Click here to enable Memory in your admin console. Using Gemini Code AssistThe full guide for Gemini Code Assist can be found on our documentation page, here are some quick tips. Invoking Gemini You can request assistance from Gemini at any point by creating a comment using either
Customization To customize Gemini Code Assist for GitHub experience, repository maintainers can create a configuration file and/or provide a custom code review style guide (such as PEP-8 for Python) by creating and adding files to a Limitations & Feedback Gemini Code Assist may make mistakes. Please leave feedback on any instances where its feedback is incorrect or counter productive. You can react with 👍 and 👎 on @gemini-code-assist comments. If you're interested in giving your feedback about your experience with Gemini Code Assist for Github and other Google products, sign up here. You can also get AI-powered code generation, chat, as well as code reviews directly in the IDE at no cost with the Gemini Code Assist IDE Extension. Footnotes
|
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Code Review
This pull request updates the configuration documentation to clarify the behavior of various properties for different GCS client types (HTTP vs. gRPC). The changes are clear and significantly improve the documentation for users. I've added a couple of minor suggestions to improve the wording for even better readability.
| [`MediaHttUploader` class](https://cloud.google.com/java/docs/reference/google-api-client/latest/com.google.api.client.googleapis.media.MediaHttpUploader). | ||
| This is used only for JSON API and for best performance should be a multiple | ||
| of 8 MiB. | ||
| Not supported by `STORAGE_CLIENT` (gRPC) when `fs.gs.bidi.enable` is `true` and for best performance should be a multiple of 8 MiB. |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
The phrasing here is a bit awkward. It combines a statement about support with a performance recommendation using 'and'. Consider rephrasing for clarity.
| Not supported by `STORAGE_CLIENT` (gRPC) when `fs.gs.bidi.enable` is `true` and for best performance should be a multiple of 8 MiB. | |
| This property is not supported by `STORAGE_CLIENT` (gRPC) when `fs.gs.bidi.enable` is `true`. For best performance, this value should be a multiple of 8 MiB. |
| It controls the parallel processing of range request. These threads will be | ||
| shared across all readVectored invocation. If the task queue of range request | ||
| is overloaded do consider increasing this value. | ||
| Supported by `HTTP_API_CLIENT`, `STORAGE_CLIENT` (gRPC) only when `fs.gs.bidi.enable` is `false`. If `fs.gs.bidi.enable` is `true`, `fs.gs.bidi.thread.count` is used instead. |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
This sentence is a bit long and combines multiple conditions. For better readability, consider breaking it down into separate sentences.
| Supported by `HTTP_API_CLIENT`, `STORAGE_CLIENT` (gRPC) only when `fs.gs.bidi.enable` is `false`. If `fs.gs.bidi.enable` is `true`, `fs.gs.bidi.thread.count` is used instead. | |
| This property is supported by `HTTP_API_CLIENT`. For `STORAGE_CLIENT` (gRPC), it is only supported when `fs.gs.bidi.enable` is `false`. If `fs.gs.bidi.enable` is `true`, `fs.gs.bidi.thread.count` is used instead. |
|
/gcbrun |
Codecov Report✅ All modified and coverable lines are covered by tests. Additional details and impacted files@@ Coverage Diff @@
## branch-4.0.x #1614 +/- ##
===============================================
Coverage ? 72.34%
Complexity ? 2158
===============================================
Files ? 128
Lines ? 10819
Branches ? 1302
===============================================
Hits ? 7827
Misses ? 2392
Partials ? 600
Flags with carried forward coverage won't be shown. Click here to find out more. ☔ View full report in Codecov by Sentry. 🚀 New features to boost your workflow:
|
Backport PR #1606