delete description about special non-reserved keywords that might still require special treatment (#21116)#21119
Conversation
ti-chi-bot
added
lgtm
size/XS
![gemini-code-assist[bot]](https://avatars.gh.lumenfield.work/in/956858?s=60&v=4){kind=small}
There was a problem hiding this comment.
Hello @ti-chi-bot, 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!
Summary of Changes
Hello, Gemini here! This pull request, authored by ti-chi-bot, appears to be an automated cherry-pick aimed at simplifying the documentation around SQL keywords in TiDB. Based on the title and the changes, the primary goal is to remove descriptions related to a specific category previously referred to as 'special non-reserved keywords' that required special treatment. This change is reflected in the keywords.md file, removing potentially confusing language and references to a specific marking ((S)) that is no longer needed.
Highlights
- Documentation Simplification: Removes a sentence from the introduction of the
keywords.mddocument that described 'special non-reserved keywords that might still require special treatment'. - Keyword List Description Update: Removes the mention of the
(S)marker used for 'Special non-reserved keywords that need to be escaped with backticks' from the description preceding the keyword list.
Changelog
- keywords.md
- Removed the sentence "However, there are special non-reserved keywords that might still require special treatment. It is recommended that you treat them as reserved keywords." from the introductory paragraph (around line 10).
- Removed the sentence "Special non-reserved keywords that need to be escaped with backticks
`are marked with(S)." from the description of the keyword list (around line 54).
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.
Code Review
This pull request effectively removes the description of 'special non-reserved keywords' from the keywords.md documentation. This change aligns with the linked technical updates in the parser and database, simplifying the documentation and removing potentially outdated or confusing information. The changes are minimal and focused, making the document clearer.
Summary of Findings
- Documentation Accuracy: The pull request correctly removes information about 'special non-reserved keywords' which appears to be outdated based on the linked technical changes in the TiDB parser and database. This improves the accuracy and clarity of the documentation.
- Adherence to Style Guide: The changes made adhere to the documentation style guide, maintaining clarity, using appropriate formatting, and employing consistent terminology.
Merge Readiness
The changes in this pull request are minor documentation updates that improve accuracy and clarity. Based on the review, there are no critical or high-severity issues, and the changes align with the project's documentation style guide. The pull request appears ready to be merged. Please note that I am unable to approve the pull request directly; another reviewer will need to do so.
|
/approve |
|
[APPROVALNOTIFIER] This PR is APPROVED This pull-request has been approved by: hfxsd The full list of commands accepted by this bot can be found here. The pull request process is described here DetailsNeeds approval from an approver in each of these files:
Approvers can indicate their approval by writing |
2 participants
This is an automated cherry-pick of #21116
First-time contributors' checklist
What is changed, added or deleted? (Required)
Which TiDB version(s) do your changes apply to? (Required)
Tips for choosing the affected version(s):
By default, CHOOSE MASTER ONLY so your changes will be applied to the next TiDB major or minor releases. If your PR involves a product feature behavior change or a compatibility change, CHOOSE THE AFFECTED RELEASE BRANCH(ES) AND MASTER.
For details, see tips for choosing the affected versions.
What is the related PR or file link(s)?
Do your changes match any of the following descriptions?