docs: Fix a bug in the example: preferredEditor: 'code' -> 'vscode'#14685
docs: Fix a bug in the example: preferredEditor: 'code' -> 'vscode'#14685wanglc02 wants to merge 2 commits intogoogle-gemini:mainfrom
Conversation
Summary of ChangesHello @wanglc02, 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 minor but important documentation correction by updating an example JSON configuration. The 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. 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.
Code Review
This pull request addresses a minor but important error in the documentation's example configuration. The preferredEditor value has been corrected from "code" to "vscode", aligning the example with the application's actual implementation. This is a valuable fix that will prevent confusion and ensure users can correctly configure their preferred editor. The change is accurate and I approve it.
|
Hi @wanglc02, thank you so much for your contribution to Gemini CLI! We really appreciate the time and effort you've put into this. We're making some updates to our contribution process to improve how we track and review changes. Please take a moment to review our recent discussion post: Improving Our Contribution Process & Introducing New Guidelines. Key Update: Starting January 26, 2026, the Gemini CLI project will require all pull requests to be associated with an existing issue. Any pull requests not linked to an issue by that date will be automatically closed. Thank you for your understanding and for being a part of our community! |
|
Hi there! Thank you for your contribution to Gemini CLI. To improve our contribution process and better track changes, we now require all pull requests to be associated with an existing issue, as announced in our recent discussion and as detailed in our CONTRIBUTING.md. This pull request is being closed because it is not currently linked to an issue. You can easily reopen this PR once you have linked it to an issue. How to link an issue: Thank you for your understanding and for being a part of our community! |
Summary
This PR fixes a configuration error in the example JSON. It updates the
preferredEditorvalue from"code"to"vscode"to ensure the setting works as expected.Details
The value
"code"was previously used in the example, but the correct identifier for Visual Studio Code in this context is"vscode". This change prevents potential confusion or errors for users copying this configuration.How to Validate
preferredEditorvalue has changed.Pre-Merge Checklist