Normalize malformed admonition labels to > **Note:** form - #23385
Conversation
ti-chi-bot
Bot
added
missing-translation-status
|
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 (15)
📝 WalkthroughWalkthroughStandardized Markdown Note and Tip callout formatting across SQL, compatibility, sync-diff-inspector, and TiDB Cloud documentation. Changes adjust blockquote spacing, indentation, and colon placement without changing instructional content. ChangesDocumentation callout formatting
Estimated code review effort: 1 (Trivial) | ~2 minutes Suggested labels: Suggested reviewers: 🚥 Pre-merge checks | ✅ 5✅ Passed checks (5 passed)
✨ Finishing Touches🧪 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 |
Two label variants deviate from both the dominant `> **Note:**` form (1007 occurrences) and every other admonition on their own page: - `>**Note:**` — no space after `>` (11 occurrences) - `> **Note**:` — colon outside the bold span (13 occurrences) Normalize these 24 labels (Note/Warning/Tip) to `> **Note:**` (space after `>`, colon inside the bold) across 15 files. The colon-less form `> **Note**` (83 occurrences) is intentionally left unchanged: it is the form used by the author templates under resources/doc-templates/, so it is a sanctioned style rather than a defect. Co-Authored-By: Claude Opus 4.8 <noreply@anthropic.com>
3eb7e70 to
86f9f09
Compare
[LGTM Timeline notifier]Timeline:
|
ti-chi-bot
Bot
removed
the
missing-translation-status
|
/approve |
|
[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 DetailsNeeds approval from an approver in each of these files:
Approvers can indicate their approval by writing |
2 participants
What is changed, added or deleted? (Required)
Normalize two malformed admonition-label variants to the dominant
> **Note:**form. Both variants deviate from the majority form (1007 occurrences) and from every other admonition on their own page:>**Note:**— no space after>(11 occurrences)> **Note**:— colon outside the bold span (13 occurrences)These 24 labels (Note / Warning / Tip) across 15 files are normalized to
> **Note:**(space after>, colon inside the bold).Why the colon-less form
> **Note**(83 occurrences) is intentionally left unchanged: it is the exact form used by the author templates underresources/doc-templates/(> **Note**,> **Warning**), so it is a sanctioned house style rather than a defect. Touching it would contradict the templates, so it is out of scope here.Background
This is a preparatory cleanup for the Japanese translation branch (
i18n-ja-release-8.5). While reverting some machine-translated Japanese callout labels (> **注記**/> **警告**/> **ヒント**) back to English so they render as localized callout boxes, the Japanese side is matched 1:1 against the English source at the same position. The malformed English variants above made that 1:1 matching ambiguous. Rather than mirror the inconsistency into the translation, we decided to normalize the English source first, then redo the Japanese-side change against a consistent base. The earlier Japanese-side PR (#23384) was closed and will be retried after this English normalization lands.Which TiDB version(s) do your changes apply to? (Required)
What is the related PR or file link(s)?
i18n-ja-release-8.5machine-translation cleanup seriesAI agent involvement
Do your changes match any of the following descriptions?
Summary by CodeRabbit