fix: correct markdown formatting to resolve build failure (#22038) #22040
Conversation
ti-chi-bot
added
do-not-merge/hold
|
@Oreoxmt This PR has conflicts, I have hold it. |
|
@ti-chi-bot: ## If you want to know how to resolve it, please read the guide in TiDB Dev Guide. 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 ti-community-infra/tichi repository. |
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, an automated cherry-pick, addresses a build failure stemming from incorrect markdown formatting in the Table of Contents. It successfully integrates a new documentation page that comprehensively describes TiDB's 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
|
ti-chi-bot
bot
added
size/L
![gemini-code-assist[bot]](https://avatars.githubusercontent.com/in/956858?s=60&v=4){kind=small}
There was a problem hiding this comment.
Code Review
This pull request aims to fix a markdown formatting issue but has introduced merge conflict markers in TOC.md. These markers must be removed to prevent build failures. Additionally, I've found a minor formatting issue and a small opportunity for improving consistency in the new documentation file ddl_embedded_analyze.md. My review includes suggestions to address these points.
TOC.md
Outdated
| <<<<<<< HEAD | ||
| ======= | ||
| - [`ANALYZE` Embedded in DDL Statements](/ddl_embedded_analyze.md) | ||
| >>>>>>> 8e254a2344 (fix: correct markdown formatting to resolve build failure (#22038)) |
There was a problem hiding this comment.
This change introduces merge conflict markers into the table of contents. This will cause rendering issues and likely break the build. Please resolve the conflict by removing the markers.
| <<<<<<< HEAD | |
| ======= | |
| - [`ANALYZE` Embedded in DDL Statements](/ddl_embedded_analyze.md) | |
| >>>>>>> 8e254a2344 (fix: correct markdown formatting to resolve build failure (#22038)) | |
| - [`ANALYZE` Embedded in DDL Statements](/ddl_embedded_analyze.md) |
| When `tidb_stats_update_during_ddl` is `ON`, executing [`MODIFY COLUMN`](/sql-statements/sql-statement-modify-column.md) or [`CHANGE COLUMN`](/sql-statements/sql-statement-change-column.md) that reorganizes an index will also run an embedded `ANALYZE` operation after the Reorg phase completes. The mechanism is the same as for `ADD INDEX`: | ||
|
|
||
| - Start collecting statistics before the index becomes visible. | ||
| - If `ANALYZE` times out, [`MODIFY COLUMN`](/sql-statements/sql-statement-modify-column.md) and [`CHANGE COLUMN`](/sql-statements/sql-statement-change-column.md) stops waiting synchronously for `ANALYZE` to finish and continues the subsequent process, making the index visible earlier to users. This means that the index statistics will be updated when `ANALYZE` finishes asynchronously. |
There was a problem hiding this comment.
For consistency with a similar sentence earlier in the document (line 50), I suggest rephrasing this part of the sentence.
| - If `ANALYZE` times out, [`MODIFY COLUMN`](/sql-statements/sql-statement-modify-column.md) and [`CHANGE COLUMN`](/sql-statements/sql-statement-change-column.md) stops waiting synchronously for `ANALYZE` to finish and continues the subsequent process, making the index visible earlier to users. This means that the index statistics will be updated when `ANALYZE` finishes asynchronously. | |
| - If `ANALYZE` times out, [`MODIFY COLUMN`](/sql-statements/sql-statement-modify-column.md) and [`CHANGE COLUMN`](/sql-statements/sql-statement-change-column.md) stops waiting synchronously for `ANALYZE` to finish and continues the subsequent process, making the index visible earlier to users. This means the index statistics will be updated after `ANALYZE` completes asynchronously. |
| +------------------------+---------+-----------+-----------------------+----------------------------------+ | ||
| 2 rows in set (0.005 sec) | ||
| ``` | ||
|
|
There was a problem hiding this comment.
This empty line contains extra spaces, which can sometimes cause markdown rendering issues. It's best to remove them.
Oreoxmt
force-pushed
the
cherry-pick-22038-to-release-8.5
branch
from
eeb79c1 to
bc01e39
Compare
ti-chi-bot
bot
added
size/XS
|
/unhold |
ti-chi-bot
bot
removed
the
do-not-merge/hold
|
/approve |
|
[APPROVALNOTIFIER] This PR is APPROVED This pull-request has been approved by: Oreoxmt 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 |
ti-chi-bot
bot
merged commit 7bc750f
into
pingcap:feature/preview-v8.5.4
2 participants
This is an automated cherry-pick of #22038
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?