Skip to content

i18n(ja): keep sample person-name data values in English to match code - #23562

Merged
qiancai merged 5 commits into
pingcap:i18n-ja-release-8.5from
yahonda:fix-proper-noun-data-values-ja
Aug 20, 2026
Merged

i18n(ja): keep sample person-name data values in English to match code#23562
qiancai merged 5 commits into
pingcap:i18n-ja-release-8.5from
yahonda:fix-proper-noun-data-values-ja

Conversation

@yahonda

@yahonda yahonda commented Aug 19, 2026

Copy link
Copy Markdown
Member

What is changed, added or deleted? (Required)

In the Japanese TiDB Cloud docs under develop/, several sample person-name data values were rendered in katakana in the prose (e.g. ヘレン・ハルキ, ボブ, アリス) while the corresponding SQL/Java/Go code samples use the English names ("Helen Haruki", 'Bob', 'Alice'). Because these names are data values that must match the surrounding code, the prose should keep them in English to avoid a mismatch between the explanation and the code.

This PR restores the English names in the prose so they match the actual values used in the code samples:

  • develop/dev-guide-update-data.md: ヘレン・ハルキ → Helen Haruki (matches SET \name` = "Helen Haruki"`)
  • develop/dev-guide-transaction-overview.md: ボブ/アリス → Bob/Alice (matches VALUES (2, 'Bob', ...), VALUES (1, 'Alice', ...))
  • develop/dev-guide-optimistic-and-pessimistic-transaction.md: ボブ/アリス → Bob/Alice (matches the "Bob"/"Alice" values in the sample programs)

A full sweep of the develop/ directory was performed; these are the only files that had this mismatch.

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.

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

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

  • This PR is translated from:
  • Other reference link(s):

AI agent involvement

  • The changes in this PR were primarily made by an AI agent on behalf of the PR author.

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
    • Standardized example names in Japanese transaction guides, using “Bob” and “Alice” consistently.
    • Updated the data update example to use “Helen Haruki,” matching related SQL and Java examples.

In dev-guide-update-data.md, the prose rendered the author's name as
ヘレン・ハルキ while the UPDATE statement uses "Helen Haruki". The same
pattern appeared in the transaction guides, where ボブ/アリス in prose
did not match the 'Bob'/'Alice' values used in the SQL/Java/Go code.

Fix the prose so the sample person names match the actual data values
used in the code samples:
- ヘレン・ハルキ -> Helen Haruki
- ボブ -> Bob, アリス -> Alice
@ti-chi-bot

ti-chi-bot Bot commented Aug 19, 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 qiancai 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 missing-translation-status This PR does not have translation status info. area/develop This PR relates to the area of TiDB App development. size/S Denotes a PR that changes 10-29 lines, ignoring generated files. labels Aug 19, 2026
@coderabbitai

coderabbitai Bot commented Aug 19, 2026

Copy link
Copy Markdown

Review Change Stack

Note

Reviews paused

It 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 reviews.auto_review.auto_pause_after_reviewed_commits setting.

Use the following commands to manage reviews:

  • @coderabbitai resume to resume automatic reviews.
  • @coderabbitai review to trigger a single review.

Use the checkboxes below for quick actions:

  • ▶️ Resume reviews
  • 🔍 Trigger review

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: a7075bc9-3bf8-4cb7-b34a-3fd3a39d1d26

📥 Commits

Reviewing files that changed from the base of the PR and between 99fb9fc and 04c4c16.

📒 Files selected for processing (1)
  • develop/dev-guide-update-data.md

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


📝 Walkthrough

Walkthrough

The documentation updates standardize person-name spellings in transaction examples and align the UPDATE example with the Latin spelling Helen Haruki.

Changes

Documentation name consistency

Layer / File(s) Summary
Transaction example names
develop/dev-guide-optimistic-and-pessimistic-transaction.md, develop/dev-guide-transaction-overview.md
Transaction examples now use Bob and Alice instead of Japanese katakana names.
UPDATE example name
develop/dev-guide-update-data.md
The UPDATE example now uses Helen Haruki instead of the katakana transliteration.

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

Merge Risk: 🟡 Moderate · up to 04c4c

The PR only aligns Japanese prose names with the English values used in existing code samples and does not change product behavior. However, a transaction explanation remains inconsistent with the displayed user IDs and the changed list markers still violate markdownlint, so those issues should be corrected before merging.

Possibly related PRs

Suggested reviewers: qiancai

🚥 Pre-merge checks | ✅ 5
✅ Passed checks (5 passed)
Check name Status Explanation
Title check ✅ Passed The title clearly summarizes the main change: keeping sample person-name data values in English to match code.
Description check ✅ Passed The description explains the changes, affected files, target branch, AI involvement, and applicable change categories.
Docstring Coverage ✅ Passed No functions found in the changed files to evaluate docstring coverage. Skipping docstring coverage check.
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.
✨ 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.

@coderabbitai coderabbitai Bot left a comment

Copy link
Copy Markdown

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Actionable comments posted: 2


ℹ️ Review info
⚙️ Run configuration

Configuration used: Path: .coderabbit.yaml

Review profile: ASSERTIVE

Plan: Pro Plus

Run ID: 099d6d6f-00be-47f6-ac9d-56ca1fff77f7

📥 Commits

Reviewing files that changed from the base of the PR and between b77d42f and 53d838a.

📒 Files selected for processing (3)
  • develop/dev-guide-optimistic-and-pessimistic-transaction.md
  • develop/dev-guide-transaction-overview.md
  • develop/dev-guide-update-data.md

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

Comment thread develop/dev-guide-optimistic-and-pessimistic-transaction.md
Comment thread develop/dev-guide-transaction-overview.md Outdated
@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 19, 2026
Co-authored-by: coderabbitai[bot] <136622811+coderabbitai[bot]@users.noreply.github.com>
yahonda pushed a commit to yahonda/docs that referenced this pull request Aug 20, 2026
This doc's SQL examples use literal string values 'San Francisco',
'San Diego', and 'New York' (e.g. WHERE city = 'San Francisco'), and
the prose repeatedly references the actual column names `city`,
`bedrooms`, `price` with backticks. The sample-data tables and prose
city-name mentions had been translated to katakana (都市/寝室数/価格
headers, サンディエゴ/サンフランシスコ/ニューヨーク), creating a
mismatch between the explanation and the runnable SQL/output it
describes.

Restored to English to match the code, per the same reasoning as
PR pingcap#23562 (sample data values that appear in code must match the
code, not be translated): table headers (City/Bedrooms/Price) and
data values (San Diego/San Francisco) in both sample-data tables,
and the specific city-name mentions in prose (San Francisco, San
Diego, New York) that correspond to the same literal values used in
the SQL query examples. Generic uses of 都市 as a concept (not a
specific city name) were left untouched.

Co-Authored-By: Claude Sonnet 5 <noreply@anthropic.com>
@ti-chi-bot ti-chi-bot Bot added the needs-1-more-lgtm Indicates a PR needs 1 more LGTM. label Aug 20, 2026
@ti-chi-bot

ti-chi-bot Bot commented Aug 20, 2026

Copy link
Copy Markdown

[LGTM Timeline notifier]

Timeline:

  • 2026-08-20 11:07:30.825067176 +0000 UTC m=+154285.996161289: ☑️ agreed by qiancai.

@qiancai
qiancai merged commit cfb32e9 into pingcap:i18n-ja-release-8.5 Aug 20, 2026
5 of 9 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

area/develop This PR relates to the area of TiDB App development. needs-1-more-lgtm Indicates a PR needs 1 more LGTM. size/S Denotes a PR that changes 10-29 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