Skip to content

docs: unify "standardized" to "normalized" for SQL statements in sql-plan-management.md (#23581) - #23590

Open
ti-chi-bot wants to merge 1 commit into
pingcap:masterfrom
ti-chi-bot:cherry-pick-23581-to-master
Open

docs: unify "standardized" to "normalized" for SQL statements in sql-plan-management.md (#23581)#23590
ti-chi-bot wants to merge 1 commit into
pingcap:masterfrom
ti-chi-bot:cherry-pick-23581-to-master

Conversation

@ti-chi-bot

@ti-chi-bot ti-chi-bot commented Aug 24, 2026

Copy link
Copy Markdown
Member

This is an automated cherry-pick of #23581

What is changed, added or deleted? (Required)

sql-plan-management.md defines the term `Normalization` and uses "normalizes" / "normalized" consistently elsewhere in the same file (e.g. "The TiDB optimizer normalizes bound SQL statements", and the sql_digest table row "Digest of a normalized SQL statement"), but 3 sentences used the inconsistent synonym "standardized" for the exact same concept (a SQL statement that has gone through Normalization). This was found while investigating a related Japanese translation inconsistency that traced back to this English source ambiguity.

Unified all 3 occurrences to "normalized" to match the file's own defined terminology.

Origin of the "standardized" wording (found via git blame):

Both trace back to the same Chinese source term "标准化" (literally "standardize"), which this file's own English translation deliberately renders as "Normalization" as its formal defined term elsewhere - the "standardized" instances are just places where that established EN term wasn't applied consistently.

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)
  • v8.5 (TiDB 8.5 versions)
  • v8.4 (TiDB 8.4 versions)
  • v8.3 (TiDB 8.3 versions)
  • v8.2 (TiDB 8.2 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)?

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

Summary by CodeRabbit

  • Documentation
    • Updated SQL Plan Management terminology to consistently use “normalized” instead of “standardized” when describing SQL statement processing.
    • Clarified wording around bindings and baseline evolution without changing documented behavior.

…plan-management.md

This file defines the term `Normalization` and uses "normalizes" /
"normalized" consistently elsewhere (e.g. "The TiDB optimizer
normalizes bound SQL statements", "Digest of a normalized SQL
statement" in the sql_digest table), but 3 sentences used the
inconsistent synonym "standardized" for the same concept. Unified to
"normalized" to match the file's own defined terminology.
@ti-chi-bot ti-chi-bot added lgtm size/XS Denotes a PR that changes 0-9 lines, ignoring generated files. type/cherry-pick-for-master This PR is cherry-picked to master from a source PR. labels Aug 24, 2026
@ti-chi-bot

ti-chi-bot Bot commented Aug 24, 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 breezewish 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 Aug 24, 2026

Copy link
Copy Markdown

Review Change Stack

No actionable comments were generated in the recent review. 🎉

ℹ️ Recent review info
⚙️ Run configuration

Configuration used: Path: .coderabbit.yaml

Review profile: ASSERTIVE

Plan: Pro Plus

Run ID: b9383960-02a7-4e25-864d-0f16cf0a2889

📥 Commits

Reviewing files that changed from the base of the PR and between 3414d20 and e1a9810.

📒 Files selected for processing (1)
  • sql-plan-management.md

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


📝 Walkthrough

Walkthrough

The documentation replaces “standardized” with “normalized” in SQL Plan Management binding and baseline evolution descriptions. The described binding rules and baseline evolution behavior remain unchanged.

Changes

SQL Plan Management terminology

Layer / File(s) Summary
Normalize SQL statement terminology
sql-plan-management.md
The “Create a binding” and “Baseline evolution” sections now use “normalized SQL statement” terminology.

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

Merge Risk: ⚪ Minimal · up to e1a98

This change only unifies SQL terminology in the documentation, with no product or runtime behavior impact; no actionable merge-blocking risk remains after normal checks and review.

🚥 Pre-merge checks | ✅ 5
✅ Passed checks (5 passed)
Check name Status Explanation
Title check ✅ Passed The title clearly identifies the documentation file and the terminology change from "standardized" to "normalized".
Description check ✅ Passed The description includes the required change summary, affected version, references, AI involvement, and change-category checklist.
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 files. (1 skipped: 1 unsupported.)
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.
✨ Finishing Touches
🧪 Generate unit tests (beta)
  • Create PR with unit tests

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.

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

Labels

lgtm size/XS Denotes a PR that changes 0-9 lines, ignoring generated files. type/cherry-pick-for-master This PR is cherry-picked to master from a source PR.

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants