-
Notifications
You must be signed in to change notification settings - Fork 2.1k
Fix Rendering issue for FC Guide #2147
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
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.
Summary of Changes
Hello @laxmareddyp, 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 primarily focuses on resolving rendering inconsistencies within the 'Function Calling Guide' by adjusting how Python code blocks are delimited. It also includes several content refinements to enhance the guide's clarity, accuracy, and overall presentation of examples and warnings.
Highlights
- Rendering Fixes: I've added
~~~pythonand~~~delimiters around Python code blocks within the guide's Jupyter notebook, Python script, and Markdown version. This change is crucial for ensuring proper rendering and syntax highlighting of code examples, addressing the 'rendering issue' mentioned in the PR title. - Content Refinements: I've simplified the security warning message associated with the
capture_code_outputfunction by removing an emoji and a specific suggestion. Additionally, I've updated and restructured several example outputs, particularly for currency conversion and flight booking scenarios, to improve their clarity and accuracy within the guide. - Example Output Updates: Minor updates were made to example outputs, including refreshing log timestamps and simplifying numerical values (e.g., changing
425.0to425) for better readability.
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 in your pull request via creating an issue comment (i.e. comment on the pull request page) using either /gemini <command> or @gemini-code-assist <command>. Below is a summary of the supported commands.
| 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 issue 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 is currently in preview and 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 to provide feedback.
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
-
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. ↩
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 rendering issues in the function calling guide. The changes primarily involve wrapping Python code blocks with ~~~ fences for correct rendering. The PR also updates and clarifies some examples in the markdown guide.
My main concern is the weakening of the security warning for the capture_code_output function, which uses eval() and exec(). The prominent warning header and the suggestion to use a sandboxed environment have been removed. I've added comments to restore these important warnings to ensure users are fully aware of the security risks.
| Executes Python code and captures any stdout output. | ||
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.
The security warning for capture_code_output appears to have been weakened. This line likely contained a ⚠️ SECURITY WARNING ⚠️ header, which is critical for a function that uses eval() and exec(). Please restore the prominent warning to ensure users are fully aware of the security risks. The full warning should also recommend using a sandboxed environment.
| ⚠️ SECURITY WARNING ⚠️ |
No description provided.