Escape Click’s Wrapping in adk deploy agent_engine example#4337
Escape Click’s Wrapping in adk deploy agent_engine example#4337ftnext wants to merge 3 commits intogoogle:mainfrom
adk deploy agent_engine example#4337Conversation
Summary of ChangesHello @ftnext, 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 resolves a display issue within 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.
Code Review
This pull request addresses a formatting issue in the adk deploy agent_engine command's help message where newlines were not being preserved. The fix involves adding \b markers to the docstring to prevent Click from re-wrapping the example code blocks. The change is correct, minimal, and consistent with the existing formatting conventions for help text in this file. The pull request is well-documented and ready to be merged.
|
Hi @ftnext , Thank you for your contribution! We appreciate you taking the time to submit this pull request. Your PR has been received by the team and is currently under review. We will provide feedback as soon as we have an update to share. |
|
Hi @Jacksunwei , can you pls review this LGTM. |
Escape Click’s Wrapping in `adk deploy agent_engine` example Merge #4337 ### Link to Issue or Description of Change **2. Or, if no issue exists, describe the change:** **Problem:** `adk deploy agent_engine` help message loses newlines in docstring formatting <img width="749" height="257" alt="スクリーンショット 2026-01-31 13 29 18" src="https://github.com/user-attachments/assets/ede7d9e7-609d-4412-acce-c80e24ec1e2f" /> **Solution:** Add `\b` on a line by itself before the formatted block ### Testing Plan This is format improvement of help message, so I think there is no need to add test case. **Unit Tests:** - [ ] I have added or updated unit tests for my change. - [x] All unit tests pass locally. ``` % pytest tests/unittests/cli # Python 3.13.8 ======================= 260 passed, 140 warnings in 7.73s ======================== ``` **Manual End-to-End (E2E) Tests:** Ran `adk deploy agent_engine --help`, then saw ``` Example: # With Express Mode API Key adk deploy agent_engine --api_key=[api_key] my_agent # With Google Cloud Project and Region adk deploy agent_engine --project=[project] --region=[region] --display_name=[app_name] my_agent ``` ### Checklist - [x] I have read the [CONTRIBUTING.md](https://github.com/google/adk-python/blob/main/CONTRIBUTING.md) document. - [x] I have performed a self-review of my own code. - [x] I have commented my code, particularly in hard-to-understand areas. - [x] I have added tests that prove my fix is effective or that my feature works. - [x] New and existing unit tests pass locally with my changes. - [x] I have manually tested my changes end-to-end. - [x] Any dependent changes have been merged and published in downstream modules. ### Additional context Same solution as #4258 COPYBARA_INTEGRATE_REVIEW=#4337 from ftnext:escape-wrapping-deploy-agent-engine-example 0944038 PiperOrigin-RevId: 877205878
Link to Issue or Description of Change
2. Or, if no issue exists, describe the change:
Problem:
adk deploy agent_enginehelp message loses newlines in docstring formattingSolution:
Add
\bon a line by itself before the formatted blockTesting Plan
This is format improvement of help message, so I think there is no need to add test case.
Unit Tests:
Manual End-to-End (E2E) Tests:
Ran
adk deploy agent_engine --help, then sawChecklist
Additional context
Same solution as #4258