Skip to content

docs: fix wording that causes mistranslation in the Japanese docs (#24491) - #24560

Open
ti-chi-bot wants to merge 4 commits into
pingcap:release-8.5from
ti-chi-bot:cherry-pick-24491-to-release-8.5
Open

ti-chi-bot wants to merge 4 commits into
pingcap:release-8.5from
ti-chi-bot:cherry-pick-24491-to-release-8.5

Conversation

@ti-chi-bot

@ti-chi-bot ti-chi-bot commented Oct 27, 2026 •

Copy link
Copy Markdown
Member

This is an automated cherry-pick of #24491

What is changed, added, or deleted? (Required)

Fix six English wording issues that make the Japanese translation wrong or awkward. The Japanese docs are machine-translated from these English lines, so fixing the English is the way to fix the Japanese.

File Before After Current Japanese
system-variables.md (tidb_enable_resource_control) "This variable is a switch for [the resource control feature]" "This variable controls whether to enable [the resource control feature]", the usual wording for Boolean variables 「この変数は…リソース制御機能のスイッチです」 ("is the switch of")
tidb-cloud/csv-config-for-import-data.md "…saved as JSON in the following way, then consider setting Backslash escape = True as follows. But this is not the standard format for CSV." "If a JSON field in the CSV source file is stored in the following way, consider setting Backslash escape = True. Note that this is not the standard format for CSV." (the previous sentence is about a JSON field, not the whole file) What follows is the source data example, not a setting, so the second "as follows" dangles. 「以下のようにJSON形式で保存されている場合は、 以下のようにBackslash escape = Trueを設定することを検討してください」 ("as follows" twice)
develop/java-app-best-practices.md, develop/dev-guide-connection-parameters.md "But if you change the three statements into the following ones: [code] Then they meet the rewrite requirement. The above…" (one sentence split across a code block) "But if you change the three statements as follows, they meet the rewrite requirement: [code] The above…" 「3つの文を次のように変更すると次のようになります。」 + 「すると、書き換え要件を満たします。」
system-variables.md (tidb_opt_join_reorder_threshold) "to get better connection orders in OLAP scenarios" "to get better join orders in OLAP scenarios". This variable is the threshold for the Join Reorder algorithm, so "connection" is a slip for "join" (found by CodeRabbit in the Japanese PR #24501). 「OLAPシナリオでの接続順序を改善するために」 ("connection order")
tidb-scheduling.md "Read/Write operations are performed on leaders, which cannot be distributed only on a few individual stores" "…performed on leaders, so leaders cannot be concentrated on only a few individual stores". "which" could refer to the operations or the leaders, and "distributed only on" is unclear. 「読み取り/書き込み操作はリーダー上で実行されますが、少数の個別のストアにのみ分散できません」 ("cannot be distributed only to a few stores", which does not say what must not happen)
tidb-scheduling.md "When Regions are in balancing, data transferring utilizes…" "When Regions are being balanced, data transferring utilizes…" 「リージョンのバランスが取れている場合、…」 ("when Regions are balanced", the opposite of "while they are being balanced")

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.

  • master (the latest development version)
  • v9.0 (TiDB 9.0 versions)
  • v8.5 (TiDB 8.5 versions)
  • v8.1 (TiDB 8.1 versions)
  • v7.5 (TiDB 7.5 versions)
  • v7.1 (TiDB 7.1 versions)
  • v6.5 (TiDB 6.5 versions)

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

  • Related code change PR links (if applicable):
  • 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

🤖 Generated with Claude Code

Summary by CodeRabbit

  • Documentation
    • Clarified when compatible INSERT ... ON DUPLICATE KEY UPDATE statements can be rewritten into a single statement.
    • Refined guidance on resource control, join ordering, CSV backslash escaping, and scheduling leaders and Regions.

yahonda and others added 4 commits October 27, 2026 13:50
- system-variables.md: describe tidb_enable_resource_control with the
  usual "controls whether to enable" instead of "is a switch for", which
  was translated literally as スイッチ.
- tidb-cloud/csv-config-for-import-data.md: drop the dangling "as
  follows" (what follows is the source data example, not a setting) and
  the "then ... But" construction.
- develop/java-app-best-practices.md and dev-guide-connection-parameters.md:
  join the sentence that was split across a code block ("If you change
  the three statements into the following ones: [code] Then they meet the
  rewrite requirement.").

Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
…reshold

Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
…cing

Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
…ackslash escape example

Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
@ti-chi-bot ti-chi-bot added area/develop This PR relates to the area of TiDB App development. lgtm size/S Denotes a PR that changes 10-29 lines, ignoring generated files. type/cherry-pick-for-release-8.5 This PR is cherry-picked to release-8.5 from a source PR. labels Oct 27, 2026
@ti-chi-bot

ti-chi-bot Bot commented Oct 27, 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 icemap 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

@coderabbitai

coderabbitai Bot commented Oct 27, 2026 •

Copy link
Copy Markdown

Review in Change Stack →

Walkthrough

This pull request updates documentation wording in batch rewrite examples, system variable descriptions, CSV import guidance, and scheduling guidance. It does not change code behavior or system variable settings.

Changes: Documentation clarifications

Layer / File(s) Summary
Batch rewrite examples
develop/dev-guide-connection-parameters.md, develop/java-app-best-practices.md
The examples clarify that compatible ON DUPLICATE KEY UPDATE statements using VALUES(a) qualify for rewriting into one statement.
System, import, and scheduling guidance
system-variables.md, tidb-cloud/csv-config-for-import-data.md, tidb-scheduling.md
Descriptions and guidance clarify resource control, join orders, CSV backslash escaping, and leader and Region balancing.

Priority: Low

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

Change: Other

Possibly related PRs

  • pingcap/docs#24491: Changes the same five documentation areas and wording; this pull request is an automated cherry-pick of that change.

Suggested reviewers: qiancai

Merge Risk: Low · up to 963e0

The PR is otherwise mergeable; only a small documentation clarity issue remains in the scheduling guidance.

Pre-merge checks: Passed 5
Check name Status Explanation
Title check Passed The title clearly summarizes the documentation wording changes and their purpose: preventing incorrect or awkward Japanese translations.
Description check Passed The description is complete. It explains the six wording fixes, affected files, applicable versions, automated cherry-pick context, and AI involvement.
Docstring Coverage Passed 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 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: 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. (5 skipped: 5 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.

❤️ 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: 1


Review info
Run configuration
Commits

Reviewing files that changed from the base of the PR and between c8a1975 and 963e057.

Files selected for processing: 5
  • develop/dev-guide-connection-parameters.md
  • develop/java-app-best-practices.md
  • system-variables.md
  • tidb-cloud/csv-config-for-import-data.md
  • tidb-scheduling.md

Included review availability: This review used your included allowance. Your plan provides up to 4 included reviews per hour; 3 remain after this review.

Comment thread tidb-scheduling.md
* Read/Write operations are performed on leaders, so leaders cannot be concentrated on only a few individual stores;
* Not all Regions are hot, so loads of all TiKV stores need to be balanced;
* When Regions are in balancing, data transferring utilizes much network/disk traffic and CPU time, which can influence online services.
* When Regions are being balanced, data transferring utilizes much network/disk traffic and CPU time, which can influence online services.

Copy link
Copy Markdown

Choose a reason for hiding this comment

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

Minor · Maintainability & Code Quality · Quick win

Use precise resource terms in the scheduling warning.

The phrase “much network/disk traffic and CPU time” is ambiguous. Replace it with a direct description of the consumed resources.

Committable suggestion
- When Regions are being balanced, data transferring utilizes much network/disk traffic and CPU time, which can influence online services.
+ When Regions are being balanced, data transfer consumes significant network bandwidth, disk I/O, and CPU time, which can affect online services.
Tools
GitHub Check: vale

[warning] 28-28:
[vale] reported by reviewdog 🐶
[PingCAP.Ambiguous] Consider using a clearer word than 'much' because it may cause confusion.

Raw Output:
{"message":"[PingCAP.Ambiguous] Consider using a clearer word than 'much' because it may cause confusion.","location":{"path":"tidb-scheduling.md","range":{"start":{"line":28,"column":63},"end":{"line":28,"column":67}}},"severity":"INFO","code":{"value":"PingCAP.Ambiguous"}}

Sources: Path instructions, Linters/SAST tools

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. lgtm size/S Denotes a PR that changes 10-29 lines, ignoring generated files. type/cherry-pick-for-release-8.5 This PR is cherry-picked to release-8.5 from a source PR.

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants