delete description about special non-reserved keywords that might still require special treatment (#21116)#21136
Conversation
Signed-off-by: ti-chi-bot <ti-community-prow-bot@tidb.io>
ti-chi-bot
added
do-not-merge/hold
|
@hfxsd This PR has conflicts, I have hold it. |
![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, providing a summary of this pull request. This PR, automatically cherry-picked from #21116, focuses on updating the documentation for keywords in TiDB. The primary intent is to remove descriptions and references to a specific category of non-reserved keywords that were previously noted as potentially requiring special treatment or escaping. This change aims to simplify the explanation of keyword classification in the documentation.
Highlights
- Documentation Update: Removes text from the
keywords.mdfile that described 'special non-reserved keywords that might still require special treatment'. - Keyword Classification Clarity: Updates the description of the keyword list to remove the mention of the
(S)marker used for these 'special non-reserved keywords'.
Changelog
- keywords.md
- Removed the sentence explaining that there are special non-reserved keywords that might still require special treatment and the recommendation to treat them as reserved (lines 10-11 in the original text).
- Removed the sentence mentioning the
(S)marker for special non-reserved keywords in the description of the keyword list (line 62 in the original text). - Added links to the documentation pages for
SELECT,UPDATE, andDELETEstatements in the introductory paragraph (line 13 in the new text).
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, an automated cherry-pick, aims to remove the description of special non-reserved keywords that might require special treatment, which simplifies the documentation around TiDB keywords. The change to remove the (S) marker and its description is correctly applied.
However, there's a critical issue in keywords.md where git conflict markers (<<<<<<< HEAD, =======, >>>>>>>) have been included in the file. These markers need to be resolved before this PR can be merged.
Summary of Findings
- Git Conflict Markers: The file
keywords.mdcontains unresolved git conflict markers (<<<<<<< HEAD,=======,>>>>>>>) which will break the document rendering. These must be resolved.
Merge Readiness
This pull request is not ready to be merged due to the presence of critical git conflict markers in keywords.md. These markers must be resolved first. Once the conflict markers are addressed, the change itself (removing the outdated keyword description and adding links) will be a good improvement. As a reviewer, I am not authorized to approve pull requests, but I recommend addressing this critical issue before seeking merge approval.
|
@gemini-code-assist[bot]: adding LGTM is restricted to approvers and reviewers in OWNERS files. DetailsIn response to this:
Instructions for interacting with me using PR comments are available here. If you have questions or suggestions related to my behavior, please file an issue against the kubernetes-sigs/prow repository. |
hfxsd
removed
the
do-not-merge/hold
|
/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?