-
Notifications
You must be signed in to change notification settings - Fork 2.8k
fix: Escape Click’s Wrapping in adk eval help
#4258
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
base: main
Are you sure you want to change the base?
Conversation
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 formatting issue in 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 aims to fix the text wrapping in the adk eval help message by using Click's \b marker. The approach is correct, but the current implementation will introduce extra newlines in the output. I've left comments with suggestions on how to adjust the formatting to prevent this, which involves moving the \b marker to be on the same line as the text it's meant to affect.
| separated list of eval names and then add that as a suffix to the eval set | ||
| file name, demarcated by a `:`. | ||
| \b |
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.
While adding \b on its own line works to prevent re-wrapping, it will also introduce an extra newline in the help output before "For example...". This is because after stripping \b, the paragraph starts with a newline character (\n).
To fix the wrapping without adding an extra blank line, you should remove this line and instead place \b at the beginning of the following line, like this:
\bFor example, we have `sample_eval_set_file.json` file that has following the| separated list of eval names and then add that as a suffix to the eval set | ||
| file name, demarcated by a `:`. | ||
| \b |
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.
| |....... eval_4 | ||
| |....... eval_5 | ||
| \b |
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.
Link to Issue or Description of Change
1. Link to an existing issue (if applicable):
adk evalhelp message loses newlines in docstring formatting #4257Testing 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 eval --help, then sawChecklist
Additional context
https://click.palletsprojects.com/en/stable/documentation/#escaping-click-s-wrapping