i18n(ja): keep SQL statement names literal in cross-reference links - #23566
Conversation
Several cross-reference links to sql-statements/*.md pages had their link text translated or paraphrased into descriptive Japanese (e.g. [テーブルの変更] instead of [ALTER TABLE]) instead of being kept as the literal SQL statement name, matching the English source and the convention used consistently elsewhere in the corpus (e.g. sql-statement-alter-table-compact.md's own "See also" links). Fixes 70 occurrences across 21 files, most concentrated in system-variable-reference.md. Also fixes two related minor completeness/casing issues found in the same sweep: [ANALYZE] should be [ANALYZE TABLE], and [Split Region] should be [SPLIT REGION].
|
[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 |
|
Note Reviews pausedIt looks like this branch is under active development. To avoid overwhelming you with review comments due to an influx of new commits, CodeRabbit has automatically paused this review. You can configure this behavior by changing the Use the following commands to manage reviews:
Use the checkboxes below for quick actions:
No actionable comments were generated in the recent review. 🎉 ℹ️ Recent review info⚙️ Run configurationConfiguration used: Path: .coderabbit.yaml Review profile: ASSERTIVE Plan: Pro Plus Run ID: 📒 Files selected for processing (3)
Included review availability: Your plan provides up to 4 included reviews per hour; 1 remains after this review. 📝 WalkthroughWalkthroughThe documentation updates standardize Japanese information-function terminology and replace Japanese reference labels with English SQL statement names. Link destinations, anchors, and behavior remain unchanged. ChangesDocumentation terminology alignment
Estimated code review effort: 2 (Simple) | ~10 minutes Merge Risk: 🔵 Low · up to The PR corrects Japanese SQL cross-reference labels, but changed list items still trigger Markdown formatting warnings and one ANALYZE TABLE link retains the shorter ANALYZE label. The change is otherwise mergeable with explicit owner follow-up on these localized documentation issues. Suggested reviewers: 🚥 Pre-merge checks | ✅ 5✅ Passed checks (5 passed)
✨ Finishing Touches 💡 1🛠️ Fix failing CI checks 💡
🧪 Generate unit tests (beta)
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 |
- develop/dev-guide-create-secondary-indexes.md, develop/dev-guide-update-data.md: remove a redundant leading word (インデックス/キー) duplicating part of the SQL statement name that now immediately follows it in the link text - statistics.md, system-variable-reference.md: fix two classes of link that the original scan's regex could not parse and therefore missed — a link whose first EN occurrence elsewhere in the same file used backtick-wrapped text (LOAD STATS/DROP STATS/LOCK STATS), and a link with a nested bracket in its own text (ADMIN SHOW DDL [JOBS|JOB QUERIES]) - functions-and-operators/information-functions.md (+6 cross- references): fix a false-friend heading, 情報機能 (feature) should be 情報関数 (functions), matching every sibling *-functions.md page and the page's own already-correct summary line
dev-guide-create-secondary-indexes.md had two more instances of the stray-word-before-link artifact already fixed elsewhere in this file: "次のようにインデックス[CREATE INDEX]" and "テーブルを作成する[CREATE TABLE]" both duplicate content already present in the (now-literal) English statement name, and neither qualifier exists in the English source. Co-Authored-By: Claude Sonnet 5 <noreply@anthropic.com>
There was a problem hiding this comment.
Actionable comments posted: 16
ℹ️ Review info
⚙️ Run configuration
Configuration used: Path: .coderabbit.yaml
Review profile: ASSERTIVE
Plan: Pro Plus
Run ID: 4f24994c-b695-4b2a-89b7-2496bd9a624c
📒 Files selected for processing (27)
TOC-tidb-cloud-essential.mdTOC-tidb-cloud-premium.mdTOC-tidb-cloud-starter.mdTOC-tidb-cloud.mdTOC.mdauto-random.mdbasic-sql-operations.mdcached-tables.mddevelop/dev-guide-choose-driver-or-orm.mddevelop/dev-guide-create-secondary-indexes.mddevelop/dev-guide-optimize-sql-best-practices.mddevelop/dev-guide-tidb-crud-sql.mddevelop/dev-guide-update-data.mddevelop/dev-guide-use-views.mdfunctions-and-operators/information-functions.mdglossary.mdsql-statements/sql-statement-explain-analyze.mdsql-statements/sql-statement-explain.mdsql-statements/sql-statement-show-stats-healthy.mdsql-statements/sql-statement-show-stats-histograms.mdsql-statements/sql-statement-show-stats-meta.mdsql-statements/sql-statement-show-table-regions.mdstatistics.mdsystem-variable-reference.mdtemporary-tables.mdtidb-cloud/sql-concepts.mdviews.md
Included review availability: Your plan provides up to 4 included reviews per hour; 2 remain after this review.
An earlier commit in this PR changed [ANALYZE] to [ANALYZE TABLE] in 6 files based on a blanket assumption, without checking each file's own English source individually. sql-statement-explain.md and sql-statement-explain-analyze.md's EN sources do say "ANALYZE TABLE", but sql-statement-show-stats-healthy.md, sql-statement-show-stats- histograms.md (2 occurrences), and sql-statement-show-stats-meta.md's EN sources say plain "ANALYZE". Reverted those 4 occurrences back to match their own file's EN source, per CodeRabbit review. Co-Authored-By: Claude Sonnet 5 <noreply@anthropic.com>
…iteration-2026-08-19 Resolved 1 conflict: develop/dev-guide-use-views.md's "CREATE VIEW Statement"/"DROP VIEW Statement" links were already synced to "CREATE VIEW"/"DROP VIEW" via PR pingcap#23573, matching the EN-side fix in PR pingcap#23568 (already merged, which removed the redundant "Statement" suffix since the linked pages' own titles don't include it). Took upstream's already-corrected version. Co-Authored-By: Claude Sonnet 5 <noreply@anthropic.com>
|
test seems not to be a GitHub user. You need a GitHub account to be able to sign the CLA. If you have already a GitHub account, please add the email address used for this commit to your account. You have signed the CLA already but the status is still pending? Let us recheck it. |
[LGTM Timeline notifier]Timeline:
|
First-time contributors' checklist
What is changed, added or deleted? (Required)
Several cross-reference links to
sql-statements/*.mdpages had their link text translated or paraphrased into descriptive Japanese (e.g.[テーブルの変更]instead of[ALTER TABLE],[インデックスの作成]instead of[CREATE INDEX]) instead of being kept as the literal SQL statement name.sql-statement-alter-table-compact.md's own links already keep[ALTER TABLE]literal). Most concentrated insystem-variable-reference.md(37 occurrences).[ANALYZE]→[ANALYZE TABLE](missing word) and[Split Region]→[SPLIT REGION](casing).[text](href)pair so it can't accidentally touch unrelated prose.sql-statement-show-create-resource-group.md's "See also" section links[CREATE RESOURCE GROUP]to the ALTER page instead of the CREATE page, andsql-statement-create-resource-group.mduses an invented link textALTER USER RESOURCE GROUPthat doesn't match its own target heading. Japanese already handles both correctly/consistently, so nothing to change on the ja side.Which TiDB version(s) do your changes apply to? (Required)
What is the related PR or file link(s)?
AI agent involvement
Do your changes match any of the following descriptions?
Summary by CodeRabbit
CREATE INDEX,ANALYZE TABLE,SPLIT REGION,CREATE VIEW, andDROP VIEW.