-
-
Notifications
You must be signed in to change notification settings - Fork 1.9k
📒 docs: clarify client migration examples #3921
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
|
Warning Rate limit exceeded@ReneWerner87 has exceeded the limit for the number of commits or files that can be reviewed per hour. Please wait 4 minutes and 26 seconds before requesting another review. ⌛ How to resolve this issue?After the wait time has elapsed, a review can be triggered using the We recommend that you space out your commits to avoid hitting the rate limit. 🚦 How do rate limits work?CodeRabbit enforces hourly rate limits for each developer per organization. Our paid plans have higher rate limits than the trial, open-source and free plans. In all cases, we re-allow further reviews after a brief timeout. Please see our FAQ for further information. 📒 Files selected for processing (1)
Note Other AI code review bot(s) detectedCodeRabbit has detected other AI code review bot(s) in this pull request and will avoid duplicating their findings in the review comments. This may lead to a less comprehensive review. WalkthroughAdded a "Configuration improvements" section to docs/whats_new.md describing centralized client defaults with per-request overrides, five migration patterns, and before/after examples for headers/timeouts, body handling, path/query helpers, agent helpers, and top-level client helpers (documentation-only change). Changes
Estimated code review effort🎯 1 (Trivial) | ⏱️ ~5 minutes
Suggested reviewers
Poem
Pre-merge checks and finishing touches✅ Passed checks (3 passed)
Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out. Comment |
Summary of ChangesHello @ReneWerner87, 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 the Fiber v3 client. It clarifies the new centralized configuration capabilities and provides practical migration examples for developers transitioning from older client usage patterns. The changes aim to make it easier for users to understand and adopt the improved client features, ensuring a smoother development experience. 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
|
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 enhances the documentation by adding several clear and helpful examples for client migration from v2 to v3. The new sections in docs/whats_new.md effectively demonstrate configuration improvements and common migration patterns. I have one suggestion to improve an example for consistency and to better promote best practices.
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.
Pull request overview
This PR enhances the v3 migration documentation by adding comprehensive client configuration examples and before/after code snippets to help developers transition from v2 to v3.
- Adds a "Configuration improvements" section demonstrating centralized client configuration with per-request overrides
- Provides three detailed migration patterns covering shared defaults, body handling, and path/query parameters
- Includes practical code examples showing v2 patterns alongside their v3 equivalents
|
/gemini review |
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 clarifies client migration examples in the documentation, which is a great improvement for users upgrading to v3. The new examples in whats_new.md clearly demonstrate the configuration improvements and common migration patterns. My review focuses on ensuring the code examples are not only clear but also follow best practices. I've pointed out a few places where response objects should be closed to prevent resource leaks, which is a critical practice to teach in examples.
Summary
Testing
Codex Task