i18n(ja): keep sample person-name data values in English to match code - #23562
Conversation
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
|
[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 (1)
Included review availability: Your plan provides up to 4 included reviews per hour; 0 remain after this review. 📝 WalkthroughWalkthroughThe documentation updates standardize person-name spellings in transaction examples and align the ChangesDocumentation name consistency
Estimated code review effort: 1 (Trivial) | ~3 minutes Merge Risk: 🟡 Moderate · up to 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: 🚥 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 |
There was a problem hiding this comment.
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
📒 Files selected for processing (3)
develop/dev-guide-optimistic-and-pessimistic-transaction.mddevelop/dev-guide-transaction-overview.mddevelop/dev-guide-update-data.md
Included review availability: Your plan provides up to 4 included reviews per hour; 2 remain after this review.
Co-authored-by: coderabbitai[bot] <136622811+coderabbitai[bot]@users.noreply.github.com>
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>
[LGTM Timeline notifier]Timeline:
|
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 (matchesSET \name` = "Helen Haruki"`)develop/dev-guide-transaction-overview.md: ボブ/アリス → Bob/Alice (matchesVALUES (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.
What is the related PR or file link(s)?
AI agent involvement
Do your changes match any of the following descriptions?
Summary by CodeRabbit