-
Notifications
You must be signed in to change notification settings - Fork 382
fix(samples): move misplaced docstring to correct position in watch_log.py #149
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?
fix(samples): move misplaced docstring to correct position in watch_log.py #149
Conversation
…og.py The docstring for log_a2a_message_parts was placed after the first function call instead of immediately after the function definition. Python only recognizes docstrings when they appear as the first statement in a function body. The misplaced string was being treated as a no-op string literal rather than documentation. Signed-off-by: Hwangjae Lee <meetrick@gmail.com>
Summary of ChangesHello @meetrick, 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 addresses a code quality improvement by correcting the placement of a docstring 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.
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 correctly moves a misplaced docstring in the log_a2a_message_parts function to its proper position, ensuring it's correctly associated with the function. This is a good fix. I've added one minor suggestion to further improve the docstring by including details about the function's parameters, which will enhance code clarity and documentation.
Co-authored-by: gemini-code-assist[bot] <176961590+gemini-code-assist[bot]@users.noreply.github.com>
Description
CONTRIBUTINGGuide.Summary
Fix misplaced docstring in
log_a2a_message_parts()function.Problem
The docstring was placed after
_load_logger()call instead of immediately after the function definition:Before (incorrect)
Solution
Move the docstring to the correct position as the first statement in the function body:
This ensures help(log_a2a_message_parts) and documentation tools properly display the function's purpose.