Repository navigation
information-schema, develop, ai: fix wrong values, links, and wording (#24489) - #24562
ti-chi-bot wants to merge 4 commits into
Conversation
- information-schema-engines.md: the column is `ENGINE`, not `ENGINES`. - information-schema-analyze-status.md: the example result shows 7 rows, not 6. - information-schema-tidb-hot-regions.md: move the backticks inside the link so that the link renders. - information-schema-tables.md: describe `CREATE_OPTIONS` as the extra options used with `CREATE TABLE`. "Creates options." reads as a verb phrase, and the Japanese translation rendered it as 「オプションを作成 します」. - information-schema-memory-usage-ops-history.md: add the missing "[" of the `tidb_server_memory_limit` link. - information-schema-statistics.md: add the missing colon after `Expression`. - dev-guide-use-temporary-tables.md: `ON COMMIT DELETE ROWS` deletes the data in the table, not the table. - dev-guide-create-database.md and dev-guide-object-naming-guidelines.md: "library" means database here; the Japanese translation rendered it literally as 「ライブラリ」. - dev-guide-third-party-tools-compatibility.md: the "third-party tools supported by TiDB" link pointed to the page itself. - serverless-driver.md: the option is `decoders`, as in the example. - vector-search-auto-embedding-overview.md: `VEC_EMBED_COSINE_DISTANCE()` calculates the cosine distance, not the similarity. - vector-search-integrate-with-llamaindex.md and vector-search-integrate-with-langchain.md: describe `<DATABASE_NAME>`, the placeholder that the connection URL uses. Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
…at comments The connection URL and the parameter list now use <DATABASE_NAME>, so use it in the "Connection string format" comments too. Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
…uideline "Metrics" means measurements; the guideline means naming criteria. The Japanese translation rendered it literally as "indicators". Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
ti-chi-bot
added
area/develop
|
[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 |
|
No actionable comments were generated in the recent review.
 |
| Layer / File(s) | Summary |
|---|---|
AI vector documentation ai/integrations/vector-search-auto-embedding-overview.md, ai/integrations/vector-search-integrate-with-langchain.md, ai/integrations/vector-search-integrate-with-llamaindex.md |
The function description now says cosine distance. LangChain and LlamaIndex connection examples and parameter descriptions use <DATABASE_NAME>. |
Developer guide corrections develop/dev-guide-create-database.md, develop/dev-guide-object-naming-guidelines.md, develop/dev-guide-third-party-tools-compatibility.md, develop/dev-guide-use-temporary-tables.md, develop/serverless-driver.md |
The pages update database terminology, temporary-table behavior, a support-page link, and the serverless driver option name. |
Information Schema reference corrections information-schema/information-schema-analyze-status.md, information-schema/information-schema-engines.md, information-schema/information-schema-memory-usage-ops-history.md, information-schema/information-schema-statistics.md, information-schema/information-schema-tables.md, information-schema/information-schema-tidb-hot-regions.md |
The pages correct descriptions and formatting. The analyze-status example reports seven rows instead of six. |
Priority:
Estimated code review effort: 2 (Simple) | ~10 minutes
Change: Other
Possibly related PRs
- pingcap/docs#24489: This is the source PR for the automated cherry-pick and contains the same documentation corrections.
- pingcap/docs#24443: This PR updates the Japanese vector documentation to use “cosine distance,” matching the terminology correction here.
Suggested reviewers: qiancai
Merge Risk: 
3f7e1
-
The documentation corrections are ready to merge with no identified production or workflow risk.
Pre-merge checks: 
-
Check name Status Explanation Title check The title clearly summarizes the documentation fixes across the INFORMATION_SCHEMA, developer, and AI sections. It is concise and related to the main changes. Description check The description covers the required change summary and affected TiDB versions. It also lists the individual corrections, AI involvement, and applicable checklist items. Optional reference-link fields … Docstring Coverage No eligible functions found in the changed files. Skipping docstring coverage check. Docstring coverage is scoped to functions touched by this diff. Documentation-only edits and deletions within survi… Linked Issues check Check skipped because no linked issues were found for this pull request. Out of Scope Changes check Check skipped because no linked issues were found for this pull request. Full details: Description check
-
Explanation
The description covers the required change summary and affected TiDB versions. It also lists the individual corrections, AI involvement, and applicable checklist items. Optional reference-link fields are present but empty.
Full details: Docstring Coverage
-
Explanation
No eligible functions found in the changed files. Skipping docstring coverage check. Docstring coverage is scoped to functions touched by this diff. Documentation-only edits and deletions within surviving functions are included; unchanged diff context and fully deleted functions are excluded. Analyzed 0 functions across 0 files. (14 skipped: 14 unsupported.)
-
Finishing Touches
-
🧪 Generate unit tests (beta)
-
- Create a new PR
-
- Autofix · Keep fixing CodeRabbit findings and required CI, and resolving merge conflicts
Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out.
Comment @coderabbitai help to get the list of available commands.
This is an automated cherry-pick of #24489
What is changed, added, or deleted? (Required)
Fix wrong values, links, and wording in the INFORMATION_SCHEMA, developer guide, and AI docs. These errors were found while reviewing the English docs for issues that affect the Japanese translation. Each fix is shown below; the same wrong text was also searched for in the rest of the docs. Two items (
CREATE_OPTIONSand "library") are wording fixes: the current English made the Japanese translation wrong.ENGINESENGINE(the table column)[TIDB_HOT_REGIONS_HISTORY](…)" (the link is inside a code span)TIDB_HOT_REGIONS_HISTORY"CREATE_OPTIONS: "Creates options."CREATE TABLE." (The Japanese translation rendered the old text as 「オプションを作成します」, "creates options".)`tidb_server_memory_limit`](…)(missing[)[`tidb_server_memory_limit`](…)ExpressionFor the index key …"Expression: For …"ON COMMIT DELETE ROWS"means the table will be deleted"decoderoption"decoders(as in the example)VEC_EMBED_COSINE_DISTANCE(): "Calculates cosine similarity"<DATABASE>, but the connection URL uses<DATABASE_NAME><DATABASE_NAME>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)?
AI agent involvement
Do your changes match any of the following descriptions?
🤖 Generated with Claude Code
Summary by CodeRabbit
<DATABASE_NAME>placeholder and clarified database creation and naming guidance.ON COMMIT DELETE ROWSremoves temporary-table data after a transaction ends.