Skip to content

Conversation

@ftnext
Copy link
Contributor

@ftnext ftnext commented Jan 25, 2026

Link to Issue or Description of Change

1. Link to an existing issue (if applicable):

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.
  • All unit tests pass locally.
% pytest tests/unittests/cli
====================== 247 passed, 147 warnings in 6.45s =======================

Manual End-to-End (E2E) Tests:

Ran adk eval --help, then saw

  For example, we have `sample_eval_set_file.json` file that has following the
  eval cases:
  sample_eval_set_file.json:
    |....... eval_1
    |....... eval_2
    |....... eval_3
    |....... eval_4
    |....... eval_5

Checklist

  • I have read the CONTRIBUTING.md document.
  • I have performed a self-review of my own code.
  • I have commented my code, particularly in hard-to-understand areas.
  • I have added tests that prove my fix is effective or that my feature works.
  • New and existing unit tests pass locally with my changes.
  • I have manually tested my changes end-to-end.
  • Any dependent changes have been merged and published in downstream modules.

Additional context

https://click.palletsprojects.com/en/stable/documentation/#escaping-click-s-wrapping

@gemini-code-assist
Copy link
Contributor

Summary of Changes

Hello @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 adk eval command's help message. By strategically inserting Click's \b escape character, the change prevents the command-line interface library from re-wrapping example text, which previously led to misaligned and hard-to-read output. The primary impact is an enhanced user experience for anyone consulting the adk eval --help documentation, as examples are now presented clearly and correctly.

Highlights

  • Help Message Formatting Fix: Addressed an issue where the adk eval command's help message was incorrectly wrapped by Click, leading to distorted example formatting.
  • Click's Wrapping Escaped: Implemented Click's \b escape sequence within the docstring of the cli_eval function to prevent automatic text wrapping for specific examples.
  • Improved Readability: Ensured that the example usage for adk eval in the help output is displayed as intended, preserving its structure and improving user comprehension.

🧠 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 Assist

The 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 /gemini <command> or @gemini-code-assist <command>. Below is a summary of the supported commands on the current page.

Feature Command Description
Code Review /gemini review Performs a code review for the current pull request in its current state.
Pull Request Summary /gemini summary Provides a summary of the current pull request in its current state.
Comment @gemini-code-assist Responds in comments when explicitly tagged, both in pull request comments and review comments.
Help /gemini help Displays a list of available commands.

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 .gemini/ folder in the base of the repository. Detailed instructions can be found here.

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

  1. Review the Privacy Notices, Generative AI Prohibited Use Policy, Terms of Service, and learn how to configure Gemini Code Assist in GitHub here. Gemini can make mistakes, so double check it and use code with caution.

@adk-bot adk-bot added the eval [Component] This issue is related to evaluation label Jan 25, 2026
Copy link
Contributor

@gemini-code-assist gemini-code-assist bot left a 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
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

medium

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
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

medium

Similar to my previous comment, adding \b on its own line here will introduce an extra newline in the help output.

To avoid this, please remove this line and add \b to the beginning of the next line:

  \bFor example, we have `sample_eval_set_id` that has following the eval cases:

|....... eval_4
|....... eval_5
\b
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

medium

Similar to my other comments, adding \b on its own line here will introduce an extra newline in the help output.

To avoid this, please remove this line and add \b to the beginning of the next line:

  \bIf we did:

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

eval [Component] This issue is related to evaluation

Projects

None yet

Development

Successfully merging this pull request may close these issues.

adk eval help message loses newlines in docstring formatting

2 participants