docs: improve readability of tools list#23700
docs: improve readability of tools list#23700Boulder1-kihara wants to merge 3 commits intogoogle-gemini:mainfrom
Conversation
Summary of ChangesHello, 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 significantly enhances the readability and user experience of the tools reference documentation. By transforming the previous table-based format into a structured, categorized list, it addresses issues with cramped text and poor rendering on various screen sizes, making the information more accessible and easier to digest for users. Highlights
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. Footnotes
|
There was a problem hiding this comment.
Code Review
This pull request reformats the docs/reference/tools.md file, changing the presentation of available tools from a table to a more structured list format. However, a review comment points out that this reformatting inadvertently removed the "Under the hood" section, which contained valuable information for developers on extending the Gemini CLI with custom tools. The PR description was also noted as inaccurate for not mentioning this content removal, and it is recommended to re-integrate this documentation.
Note: Security Review has been skipped due to the limited scope of the PR.
I am having trouble creating individual review comments. Click here to see my feedback.
docs/reference/tools.md (90-96)
This pull request is intended to improve readability by reformatting the tools list, but it also removes the "Under the hood" section. This section contains valuable information for developers on how to extend Gemini CLI with custom tools, including mentioning the tools.discoveryCommand setting. The PR description states that only formatting was changed, which is not accurate as this content has been removed. Please consider re-integrating this information to avoid losing important documentation for developers.
Good catch! Thank you for the review. I have restored the missing 'Under the hood' section in the latest commit so no developer documentation is lost |
|
Good catch! Thank you for the review. I have restored the missing 'Under the hood' section in the latest commit so no developer documentation is lost |
There was a problem hiding this comment.
Code Review
This pull request refactors the docs/reference/tools.md file. The primary change involves converting the 'Available tools' section from a Markdown table into a more structured and readable list format, utilizing headings and bullet points to detail each tool and its parameters. Additionally, a prettier-ignore comment was removed, and a newline was added at the end of the file. I have no feedback to provide as there were no review comments.
Note: Security Review has been skipped due to the limited scope of the PR.
|
Hi, this issue is already fixed by a PR submitted by a contributor assigned to issue. Before creating future PRs, please make sure the issue is labeled as help-wanted and unassigned, and assign to yourself with the /assign comment. Thanks! |
Summary
Reformatted the tools reference documentation from a cramped table into a highly readable, categorized list.
Details
The previous table format squished tool descriptions and parameters, making them difficult to read on smaller screens or GitHub's default markdown preview. This PR extracts the tools into a structured, bulleted list grouped by their primary function category. No tool descriptions or parameters were altered or removed, only formatted.
Related Issues
Fixes #21504
How to Validate
Pre-Merge Checklist