Fix tool name capitalization for product names to prevent mistranslation#23043
Fix tool name capitalization for product names to prevent mistranslation#23043yahonda wants to merge 2 commits into
Conversation
ti-chi-bot
Bot
added
the
missing-translation-status
|
[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 |
ti-chi-bot
Bot
added
the
size/S
![gemini-code-assist[bot]](https://avatars.githubusercontent.com/in/956858?s=60&v=4){kind=small}
There was a problem hiding this comment.
Code Review
This pull request standardizes the capitalization of various component names (such as Syncer, Pump, Lightning, and TiFlash) across multiple documentation files. The review feedback provides actionable suggestions to further align the text with the style guide, including converting passive voice to active voice, writing in the second person ("you"), correcting grammatical issues, and ensuring consistent terminology (e.g., using "parameter" instead of "item" and capitalizing join types).
Important
The consumer version of Gemini Code Assist on GitHub is being sunset. Starting June 18, 2026, new organization installations will be blocked, and all code review activity will officially cease on July 17, 2026.
For more details on the timeline and next steps, please review the Help Documentation.
| In the second case, DM does not know which binlog events after the checkpoint are executed in the downstream. To ensure that repeatedly executed binlog events do not cause any problems, DM automatically enables safe mode during the first two checkpoint intervals. The default interval between two checkpoints is 30 seconds, which means when a normal incremental replication task starts, safe mode is enforced for the first 60 seconds (2 * 30 seconds). | ||
|
|
||
| Usually, it is not recommended to change the checkpoint interval to adjust the safe mode period at the beginning of the incremental replication task. However, if you do need a change, you can [manually enable safe mode](#manually-enable) (recommended) or change the `checkpoint-flush-interval` item in syncer configuration. | ||
| Usually, it is not recommended to change the checkpoint interval to adjust the safe mode period at the beginning of the incremental replication task. However, if you do need a change, you can [manually enable safe mode](#manually-enable) (recommended) or change the `checkpoint-flush-interval` item in Syncer configuration. |
There was a problem hiding this comment.
According to the repository style guide, we should write in the second person ("you") when addressing users and avoid passive/impersonal phrasing like "it is not recommended". Also, "item" should be replaced with "parameter" for better technical terminology consistency.
Suggested change:
Usually, you should not change the checkpoint interval to adjust the safe mode period at the beginning of the incremental replication task. However, if you must change it, you can [manually enable safe mode](#manually-enable) (recommended) or change the `checkpoint-flush-interval` parameter in the Syncer configuration.References
- Write in second person ('you') when addressing users. (link)
| + TiDB Binlog | ||
| - Modify the default value of `defaultBinlogItemCount` in Drainer from 65536 to 512 to reduce the chance of OOM on Drainer startup [#721](https://github.com/pingcap/tidb-binlog/pull/721) | ||
| - Optimize the offline logic for pump server to avoid potential offline congestions [#701](https://github.com/pingcap/tidb-binlog/pull/701) | ||
| - Optimize the offline logic for Pump server to avoid potential offline congestions [#701](https://github.com/pingcap/tidb-binlog/pull/701) |
There was a problem hiding this comment.
Adding the definite article "the" before "Pump server" and changing the uncountable noun "congestions" to "congestion" improves the grammatical correctness of this release note.
| - Optimize the offline logic for Pump server to avoid potential offline congestions [#701](https://github.com/pingcap/tidb-binlog/pull/701) | |
| - Optimize the offline logic for the Pump server to avoid potential offline congestion [#701](https://github.com/pingcap/tidb-binlog/pull/701) |
References
- Correct English grammar, spelling, and punctuation mistakes. (link)
ti-chi-bot
Bot
added
size/XS
yahonda
force-pushed
the
topic/fix-tool-names-capitalization-release-8.5
branch
from
242fd24 to
49e188b
Compare
1 participant
What is changed, added or deleted? (Required)
Changed lowercase product names to proper capitalization in prose text to prevent mistranslation during localization (e.g., Japanese translation):
Note: 'syncer' is not changed as it is not maintained and should remain lowercase.
Command line references, file names, URLs, paths, and configuration values remain unchanged.
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)?
Do your changes match any of the following descriptions?