feat(docs): add devsite-help and snippets for Retries, Update Masks, and OCC for IAM #15308
Conversation
Summary of ChangesHello @bshaffer, 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 significantly enhances the documentation for Google Cloud .NET client libraries by introducing three new guides focused on advanced usage patterns. These guides cover Optimistic Concurrency Control for IAM policies, flexible retry and timeout configurations, and efficient partial resource updates using update masks. Each guide is complemented by practical C# code snippets, providing developers with clear instructions and examples to implement these critical features effectively. Highlights
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
|
|
Pull request diff results |
![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 adds valuable documentation and examples for Retries, Update Masks, and Optimistic Concurrency Control for IAM. The documentation content is clear and well-structured. However, all the new C# code snippets contain several compilation errors that need to be addressed. These include incorrect async method signatures, use of an undefined _fixture variable, a missing semicolon, and unused using directives. I've left specific comments with suggestions to fix these issues. Once these are resolved, the snippets will be great examples for users.
bshaffer
force-pushed
the
add-client-help-docs
branch
from
ad64163 to
cd55d59
Compare
|
Pull request diff results |
amanda-tarafa
left a comment
amanda-tarafa
left a comment
There was a problem hiding this comment.
Let me know how I can help.
| string projectId = "your-project-id"; | ||
| string secretId = "test-secret"; |
There was a problem hiding this comment.
So that this is run, these need to come from the fixture.
There was a problem hiding this comment.
There is no secret in the fixture, should I add a _fixture.CreateSecret()?
docs/devsite-help/occ-for-iam.md
Outdated
| @@ -0,0 +1,26 @@ | |||
| # Optimistic Concurrency Control (OCC) Loop for IAM | |||
There was a problem hiding this comment.
| # Optimistic Concurrency Control (OCC) Loop for IAM | |
| # Optimistic Concurrency Control (OCC) for IAM |
There was a problem hiding this comment.
And also, why does this need to be IAM specific? I think we can use IAM for examples but the same principles apply to many APIs that have Etags for their resources? (I should have left this commenton the initial content review, but it only occured to me now).
There was a problem hiding this comment.
Yes I agree! I think IAM is just the most common use-case, so it's the one we decided to use.
I can remove IAM from the title, and reword the sample to make it clearer that IAM is only one use of OCC, if you think that would be better
2 participants
I followed the examples of other pages in
docs/devsite-help, but it's quite possible I'm missing a critical aspect. I also am not sure how these will be tested.I ran all samples locally to verify they worked but please take a look and review