-
Notifications
You must be signed in to change notification settings - Fork 708
fix typo in index key encoding format (tableID -> TableID, indexID -> IndexID) (#22003) #22006
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
fix typo in index key encoding format (tableID -> TableID, indexID -> IndexID) (#22003) #22006
Conversation
Updated documentation to consistently use 'TableID' and 'IndexID' instead of 'tableID' and 'indexID' in key encoding examples and API references for clarity and consistency.
Co-authored-by: Aolin <aolinz@outlook.com>
Summary of ChangesHello @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! This pull request focuses on improving the consistency and readability of the TiDB documentation by correcting capitalization for 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 aims to fix typos for consistency, changing tableID to TableID and indexID to IndexID. The changes are a good step in the right direction. I've added one specific suggestion in troubleshoot-hot-spot-issues.md to also correct rowID to RowID for consistency. I also noticed that troubleshoot-write-conflicts.md still has several instances of tableID and indexID in lowercase that were not updated. While they are outside the current diff, it would be great to address them in this PR to make the documentation fully consistent.
|
/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
Needs approval from an approver in each of these files:
Approvers can indicate their approval by writing |
This is an automated cherry-pick of #22003
First-time contributors' checklist
What is changed, added or deleted? (Required)
Changed
tableIDandindexIDtoTableIDandIndexIDto match the naming style used in other parts of the document.https://docs.pingcap.com/tidb/stable/tidb-computing/#mapping-of-indexed-data-to-key-value
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?