Skip to content

i18n(ja): fix broken multiplication-sign spacing in cost-model.md - #23605

Merged
qiancai merged 1 commit into
pingcap:i18n-ja-release-8.5from
yahonda:fix-cost-model-asterisk-spacing
Aug 26, 2026
Merged

i18n(ja): fix broken multiplication-sign spacing in cost-model.md#23605
qiancai merged 1 commit into
pingcap:i18n-ja-release-8.5from
yahonda:fix-cost-model-asterisk-spacing

Conversation

@yahonda

@yahonda yahonda commented Aug 26, 2026

Copy link
Copy Markdown
Member

What is changed, added or deleted? (Required)

Fixes a regression introduced by #23602's automated MD037 (no-space-in-emphasis) fix: it misidentified the literal multiplication asterisk in the index-cost formula as Markdown emphasis markup and stripped the surrounding spaces, turning 20 * 8 into 20* 8.

This escapes the first asterisk in each formula (\*), matching how the English source (cost-model.md) already escapes it, so markdownlint no longer treats it as emphasis while keeping the formula readable.

Found while reviewing/rebasing PR #23594.

Which TiDB version(s) do your changes apply to? (Required)

  • i18n-ja-release-8.5 (TiDB Japanese documentation for TiDB 8.5 versions)

What is the related PR or file link(s)?

Do your changes match any of the following descriptions?

  • Delete files
  • Change aliases
  • Need modification after applied to another branch
  • Might cause conflicts after applied to another branch

Summary by CodeRabbit

  • Documentation
    • Improved formatting and consistency in index cost calculation examples.
    • Clarified multiplication symbols and spacing without changing the calculations or explanations.

The markdownlint MD037 auto-fix in pingcap#23602 misidentified the literal
multiplication asterisk as emphasis markup and stripped the
surrounding spaces, producing "20* 8" instead of "20 * 8". Escapes
the first asterisk (matching the English source) so markdownlint no
longer treats it as emphasis.
@ti-chi-bot ti-chi-bot Bot added the missing-translation-status This PR does not have translation status info. label Aug 26, 2026
@ti-chi-bot

ti-chi-bot Bot commented Aug 26, 2026

Copy link
Copy Markdown

[APPROVALNOTIFIER] This PR is NOT APPROVED

This pull-request has been approved by:
Once this PR has been reviewed and has the lgtm label, please assign breezewish for approval. For more information see the Code Review Process.
Please ensure that each of them provides their approval before proceeding.

The full list of commands accepted by this bot can be found here.

Details Needs approval from an approver in each of these files:

Approvers can indicate their approval by writing /approve in a comment
Approvers can cancel approval by writing /approve cancel in a comment

@ti-chi-bot ti-chi-bot Bot added the size/XS Denotes a PR that changes 0-9 lines, ignoring generated files. label Aug 26, 2026
@coderabbitai

coderabbitai Bot commented Aug 26, 2026

Copy link
Copy Markdown

Review Change Stack

No actionable comments were generated in the recent review. 🎉

ℹ️ Recent review info
⚙️ Run configuration

Configuration used: Path: .coderabbit.yaml

Review profile: ASSERTIVE

Plan: Pro Plus

Run ID: e89fb689-e53a-4bec-8265-c0b995740efe

📥 Commits

Reviewing files that changed from the base of the PR and between 9ef6b6f and 5159562.

📒 Files selected for processing (1)
  • cost-model.md

Included review availability: Your plan provides up to 4 included reviews per hour; 1 remains after this review.


📝 Walkthrough

Walkthrough

インデックス bc のコスト計算式で、乗算記号と空白表記を修正しました。計算値と説明内容は変更していません。

Changes

インデックスコスト計算例

Layer / File(s) Summary
コスト計算式の表記修正
cost-model.md
インデックス bc の計算式の乗算記号と空白表記を修正しました。

Estimated code review effort: 1 (Trivial) | ~2 minutes

Merge Risk: ⚪ Minimal · up to 51595

This localized documentation change restores readable multiplication-sign spacing without introducing actionable merge-blocking risk; it is merge-ready after normal checks and review.

🚥 Pre-merge checks | ✅ 5
✅ Passed checks (5 passed)
Check name Status Explanation
Description check ✅ Passed The description explains the regression, identifies the fix, specifies the affected Japanese 8.5 documentation version, and includes a related reference. Optional checklist sections are omitted, but t…
Title check ✅ Passed The title clearly and concisely describes the main change: fixing multiplication-sign spacing in the Japanese cost-model documentation.
Docstring Coverage ✅ Passed No functions found in the changed files to evaluate docstring coverage. Skipping docstring coverage check. Docstring coverage is scoped to functions touched by this diff. Analyzed 0 functions across 0…
Linked Issues check ✅ Passed Check skipped because no linked issues were found for this pull request.
Out of Scope Changes check ✅ Passed Check skipped because no linked issues were found for this pull request.
Full details: Description check

Explanation

The description explains the regression, identifies the fix, specifies the affected Japanese 8.5 documentation version, and includes a related reference. Optional checklist sections are omitted, but the required content is complete.

Full details: Docstring Coverage

Explanation

No functions found in the changed files to evaluate docstring coverage. Skipping docstring coverage check. Docstring coverage is scoped to functions touched by this diff. Analyzed 0 functions across 0 files. (1 skipped: 1 unsupported.)

✨ Finishing Touches 💡 1
🛠️ Fix failing CI checks 💡
  • Create stacked PR
  • Commit on current branch
🧪 Generate unit tests (beta)
  • Create PR with unit tests

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.

❤️ Share

Comment @coderabbitai help to get the list of available commands.

@qiancai qiancai added translation/no-need No need to translate this PR. and removed missing-translation-status This PR does not have translation status info. labels Aug 26, 2026
yahonda added a commit to yahonda/docs that referenced this pull request Aug 26, 2026
Rebased onto i18n-ja-release-8.5 after pingcap#23602 merged the markdownlint
conformance fixes. Also escaped a literal multiplication asterisk
formula in statement-summary-tables.md that was already failing
MD037 in the pre-rebase branch (same class of issue as pingcap#23605's
cost-model.md fix), matching how the English source escapes it.
@ti-chi-bot ti-chi-bot Bot added the needs-1-more-lgtm Indicates a PR needs 1 more LGTM. label Aug 26, 2026
@ti-chi-bot

ti-chi-bot Bot commented Aug 26, 2026

Copy link
Copy Markdown

[LGTM Timeline notifier]

Timeline:

  • 2026-08-26 02:47:22.011738469 +0000 UTC m=+642677.182832601: ☑️ agreed by qiancai.

@qiancai
qiancai merged commit 5ee1cbb into pingcap:i18n-ja-release-8.5 Aug 26, 2026
5 of 9 checks passed
yahonda added a commit to yahonda/docs that referenced this pull request Aug 27, 2026
Rebased onto i18n-ja-release-8.5 after pingcap#23602 merged the markdownlint
conformance fixes. Also escaped a literal multiplication asterisk
formula in statement-summary-tables.md that was already failing
MD037 in the pre-rebase branch (same class of issue as pingcap#23605's
cost-model.md fix), matching how the English source escapes it.
@yahonda
yahonda deleted the fix-cost-model-asterisk-spacing branch August 28, 2026 06:14
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

needs-1-more-lgtm Indicates a PR needs 1 more LGTM. size/XS Denotes a PR that changes 0-9 lines, ignoring generated files. translation/no-need No need to translate this PR.

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants