Skip to content

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

Merged
ti-chi-bot[bot] merged 4 commits into
pingcap:masterfrom
yahonda:fix-wording-that-causes-japanese-mistranslation
Oct 27, 2026
Merged

ti-chi-bot[bot] merged 4 commits into
pingcap:masterfrom
yahonda:fix-wording-that-causes-japanese-mistranslation

Conversation

@yahonda

@yahonda yahonda commented Oct 19, 2026 •

Copy link
Copy Markdown
Member

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 batch INSERT ... ON DUPLICATE KEY UPDATE rewrite requirements and examples.
    • Improved descriptions for resource control and join reorder system variables.
    • Updated CSV import guidance for handling non-standard JSON formats with backslash escapes.

- 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>
@ti-chi-bot

ti-chi-bot Bot commented Oct 19, 2026

Copy link
Copy Markdown

Skipping CI for Draft Pull Request.
If you want CI signal for your change, please convert it to an actual PR.
You can still manually trigger a test run with /test all

@ti-chi-bot ti-chi-bot Bot added do-not-merge/work-in-progress Indicates that a PR should not merge because it is a work in progress. area/develop This PR relates to the area of TiDB App development. labels Oct 19, 2026
@coderabbitai

coderabbitai Bot commented Oct 19, 2026 •

Copy link
Copy Markdown

Review in Change Stack →

📝 Walkthrough

The documentation updates clarify batch INSERT ... ON DUPLICATE KEY UPDATE rewrite examples, revise two system-variable descriptions, and reword CSV import guidance for non-standard JSON content.

Changes: Batch INSERT rewrite guidance

Layer / File(s) Summary
Clarify batch rewrite examples
develop/dev-guide-connection-parameters.md, develop/java-app-best-practices.md
Both guides clarify that matching update expressions allow batch INSERT statements to be rewritten as one multi-value INSERT. The examples distinguish statements with differing expressions.

System-variable wording

Layer / File(s) Summary
Update system-variable guidance
system-variables.md
The resource-control description is reworded. The join-reorder recommendation now refers to join orders.

CSV import guidance

Layer / File(s) Summary
Revise Backslash Escape guidance
tidb-cloud/csv-config-for-import-data.md
The guidance for non-standard JSON CSV content is reworded without changing the recommended setting.

Priority: ⬇️ Low

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

Change: Other

Suggested reviewers: qiancai

Merge Risk: 🔵 Low · up to 1ae25

The PR is low risk, but the two wording corrections should be applied to avoid misleading documentation and translations.

Architecture risk: 🔵 Low · up to 1ae25

The change affects 3 systems.

Changed systems: develop, system-variables.md, tidb-cloud

Architecture concerns
No architecture-level concerns identified.

Review details

Systems and components

  • observed — develop (service) was modified; 2 changed files map to changed impact.
  • observed — system-variables.md (service) was modified; 1 changed file maps to changed impact.
  • observed — tidb-cloud (service) was modified; 1 changed file maps to changed impact.

Before / after behavior

  • observed — Modified behavior in develop/dev-guide-connection-parameters.md: Updated the batch-rewrite explanation to distinguish non-rewritable statements with differing update expressions from statements using the uniform VALUES(a) expression, which satisfy the rewrite requirement.
  • observed — Modified behavior in develop/java-app-best-practices.md: Reworded the batch-rewrite explanation and separated the qualifying SQL examples from the resulting rewritten statement; the required identical a = values(a) update expressions remain explicit.
  • observed — Modified behavior in system-variables.md: Reworded the tidb_enable_resource_control description without changing its documented behavior.
  • observed — Modified behavior in system-variables.md: Corrected the tidb_opt_join_reorder_threshold recommendation from “connection orders” to “join orders.”
Pre-merge checks: Passed 5
Check name Status Explanation
Title check Passed The title clearly summarizes the main change: wording fixes intended to prevent mistranslation in Japanese 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.
Description check Passed The pull request description includes the required change summary, affected versions, related-links section, AI involvement, and change-category checklist. The optional first-time contributors' checkl…
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. (4 skipped: 4 unsupported.)

Full details: Description check

Explanation

The pull request description includes the required change summary, affected versions, related-links section, AI involvement, and change-category checklist. The optional first-time contributors' checklist is omitted, which is permitted when the author is not a first-time contributor.

✨ 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.

@ti-chi-bot ti-chi-bot Bot added missing-translation-status This PR does not have translation status info. size/S Denotes a PR that changes 10-29 lines, ignoring generated files. labels Oct 19, 2026
@yahonda
yahonda marked this pull request as ready for review October 20, 2026 00:14
@ti-chi-bot ti-chi-bot Bot removed the do-not-merge/work-in-progress Indicates that a PR should not merge because it is a work in progress. label Oct 20, 2026
…reshold

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

@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: Repository: pingcap/docs/.coderabbit.yaml
  • Review profile: ASSERTIVE
  • Plan: Advanced
  • Run ID: 894e23b0-55b1-4499-964d-c2b9c47abef5
📥 Commits

Reviewing files that changed from the base of the PR and between 3ba897a and 1ae2546.

📒 Files selected for processing: 4
  • develop/dev-guide-connection-parameters.md
  • develop/java-app-best-practices.md
  • system-variables.md
  • tidb-cloud/csv-config-for-import-data.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 system-variables.md
Comment thread tidb-cloud/csv-config-for-import-data.md Outdated
yahonda and others added 2 commits October 20, 2026 14:09
…cing

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

Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
@qiancai qiancai added the translation/no-need No need to translate this PR. label Oct 27, 2026
@ti-chi-bot ti-chi-bot Bot removed the missing-translation-status This PR does not have translation status info. label Oct 27, 2026
@qiancai qiancai removed the translation/no-need No need to translate this PR. label Oct 27, 2026
@ti-chi-bot ti-chi-bot Bot added the missing-translation-status This PR does not have translation status info. label Oct 27, 2026
@qiancai qiancai added translation/doing This PR's assignee is translating this PR. needs-cherry-pick-release-8.5 Should cherry pick this PR to release-8.5 branch. and removed missing-translation-status This PR does not have translation status info. labels Oct 27, 2026
@qiancai qiancai self-assigned this Oct 27, 2026
@qiancai qiancai added the lgtm label Oct 27, 2026
@qiancai

qiancai commented Oct 27, 2026

Copy link
Copy Markdown
Collaborator

/approve

@ti-chi-bot

ti-chi-bot Bot commented Oct 27, 2026

Copy link
Copy Markdown

[APPROVALNOTIFIER] This PR is APPROVED

This pull-request has been approved by: qiancai

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

The pull request process is described 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 approved label Oct 27, 2026
@ti-chi-bot
ti-chi-bot Bot merged commit 2a1ae47 into pingcap:master Oct 27, 2026
12 checks passed
@ti-chi-bot

Copy link
Copy Markdown
Member

In response to a cherrypick label: new pull request created to branch release-8.5: #24560.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

approved area/develop This PR relates to the area of TiDB App development. lgtm needs-cherry-pick-release-8.5 Should cherry pick this PR to release-8.5 branch. size/S Denotes a PR that changes 10-29 lines, ignoring generated files. translation/doing This PR's assignee is translating this PR.

Projects

None yet

Development

Successfully merging this pull request may close these issues.

3 participants