You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
{{ message }}
Repository navigation
docs: fix wording that causes mistranslation in the Japanese docs (#24491) - #24560
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.
"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.
"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…"
"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.
- 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>
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:
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.
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: 5
Check name
Status
Explanation
Title check
The title clearly summarizes the documentation wording changes and their purpose: preventing incorrect or awkward Japanese translations.
Description check
The description is complete. It explains the six wording fixes, affected files, applicable versions, automated cherry-pick context, and AI involvement.
Docstring Coverage
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
Check skipped because no linked issues were found for this pull request.
Out of Scope Changes check
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.
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.
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
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
area/developThis PR relates to the area of TiDB App development.lgtmsize/SDenotes a PR that changes 10-29 lines, ignoring generated files.type/cherry-pick-for-release-8.5This PR is cherry-picked to release-8.5 from a source PR.
2 participants
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
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.
system-variables.md(tidb_enable_resource_control)tidb-cloud/csv-config-for-import-data.mdBackslash escape = Trueas follows. But this is not the standard format for CSV."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.Backslash escape = Trueを設定することを検討してください」 ("as follows" twice)develop/java-app-best-practices.md,develop/dev-guide-connection-parameters.mdsystem-variables.md(tidb_opt_join_reorder_threshold)tidb-scheduling.mdtidb-scheduling.mdWhich 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?
🤖 Generated with Claude Code
Summary by CodeRabbit
INSERT ... ON DUPLICATE KEY UPDATEstatements can be rewritten into a single statement.