-
Notifications
You must be signed in to change notification settings - Fork 9.8k
fixed grammar mistake #14652
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?
fixed grammar mistake #14652
Conversation
|
Thanks for your pull request! It looks like this may be your first contribution to a Google open source project. Before we can look at your pull request, you'll need to sign a Contributor License Agreement (CLA). View this failed invocation of the CLA check for more information. For the most up to date status, view the checks section at the bottom of the pull request. |
Summary of ChangesHello @itsuki-1, 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 fix within the core package. It specifically corrects a JSDoc tag to align with standard conventions, improving the accuracy and utility of generated documentation and IDE hints. 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.
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 fixes a small typo in a JSDoc comment within tools.ts, correcting @params to @param. This change is correct and improves documentation clarity. Given the nature of the change and the requested review severity of high and critical, I have no further comments.
iqbalbhatti49
left a comment
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.
Well
Summary
Fixes a syntax error in the JSDoc comments within the core package. specifically correcting an invalid tag in
tools.ts.Details
Changed the JSDoc tag
@paramsto the correct standard@paramon line 384 of/packages/core/src/tools/tools.ts. This ensures that IDEs and documentation generators parse the function parameters correctly.Related Issues
N/A
How to Validate
/packages/core/src/tools/tools.ts.@paraminstead of@params.npm run buildor the project's lint command to ensure no regressions, though this is a comment-only change.Pre-Merge Checklist