-
Notifications
You must be signed in to change notification settings - Fork 710
add correct config item in comment #22393
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: master
Are you sure you want to change the base?
Conversation
Corrected the config item in the SQL command.
|
[APPROVALNOTIFIER] This PR is NOT APPROVED This pull-request has been approved by: The full list of commands accepted by this bot can be found here. DetailsNeeds approval from an approver in each of these files:Approvers can indicate their approval by writing |
Summary of ChangesHello @lance6716, 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 improves the accuracy of the documentation by correcting an inline comment within an SQL example in Highlights
🧠 New Feature in Public Preview: You can now enable Memory to help Gemini Code Assist learn from your team's feedback. This makes future code reviews more consistent and personalized to your project's style. Click here to enable Memory in your admin console. 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 improves the documentation by adding a clarifying comment to an example of an incorrect command. My review includes a suggestion to format the configuration item within the comment according to the style guide, which will enhance readability.
|
|
||
| ```sql | ||
| set config tikv `log-level`='warn'; | ||
| set config tikv `log-level`='warn'; -- correct config item is log.level |
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.
Thanks for adding this clarification. To improve readability and adhere to the style guide, it's best to format configuration items within backticks and ensure comments are complete sentences.
| set config tikv `log-level`='warn'; -- correct config item is log.level | |
| set config tikv `log-level`='warn'; -- The correct config item is `log.level`. |
References
- The style guide specifies that configuration items should be enclosed in backticks for proper formatting. (link)
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.
Pull request overview
This PR corrects documentation by adding a clarifying comment in a SQL command example, indicating that the correct configuration item is log.level rather than log-level (with hyphen).
Changes:
- Added an inline SQL comment to clarify that the correct TiKV config item is
log.levelin an error demonstration example
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
|
|
||
| ```sql | ||
| set config tikv `log-level`='warn'; | ||
| set config tikv `log-level`='warn'; -- correct config item is log.level |
Copilot
AI
Feb 2, 2026
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.
The inline SQL comment will be included when users copy this code using the copyable button. Since this example demonstrates an error case (as indicated by the section "If an error occurs during the batch modification, a warning is returned"), including the correction in a copyable SQL comment may be confusing. Consider moving this clarification to a markdown note or regular text outside the code block, similar to how other documentation in this repository handles explanatory notes for code examples.
|
@lance6716: The following test failed, say
Full PR test history. Your PR dashboard. DetailsInstructions 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. I understand the commands that are listed here. |
Corrected the config item in the SQL command.
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?