Skip to content

functions-and-operators, releases: clarify TIDB_DECODE_SQL_DIGESTS wording - #23686

Open
yahonda wants to merge 5 commits into
pingcap:masterfrom
yahonda:fix-en-decode-sql-digests-wording
Open

functions-and-operators, releases: clarify TIDB_DECODE_SQL_DIGESTS wording#23686
yahonda wants to merge 5 commits into
pingcap:masterfrom
yahonda:fix-en-decode-sql-digests-wording

Conversation

@yahonda

@yahonda yahonda commented Sep 1, 2026

Copy link
Copy Markdown
Member

What is changed, added or deleted? (Required)

Rewords the parenthetical describing TIDB_DECODE_SQL_DIGESTS()'s output from
"a form without formats and arguments" to "without value formats or arguments",
in 4 places (3 in functions-and-operators/tidb-functions.md, 1 in
releases/release-5.2.0.md).

The original phrasing uses "form" and "formats" as two separate words with the
same root meaning right next to each other ("a form without formats"), which
reads as slightly self-contradictory even in English, and becomes worse once
translated: in Japanese, both "form" and "format" map to the same word (形式),
so the translated sentence ends up reading as "a 形式 without 形式" — literally
"a form without form" — with no way to distinguish the two senses. Simplifying
to a single clear phrase avoids this.

Found while reviewing the Japanese translation for this exact confusion.

Which TiDB version(s) do your changes apply to? (Required)

  • master (the latest development version)

What is the related PR or file link(s)?

  • 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

Summary by CodeRabbit

  • Documentation
    • Clarified that normalized SQL returned by TIDB_DECODE_SQL_DIGESTS() excludes literal value formats and arguments.
    • Updated the function reference and release notes to describe replaced values using placeholders such as ? or ....

…rding

Reword "a form without formats and arguments" to "without value formats
or arguments" to remove the redundant use of "form"/"formats" -- when
translated, both words map to the identical term in some languages,
making the parenthetical read as self-contradictory (a "form" without
"format").
@ti-chi-bot ti-chi-bot Bot added missing-translation-status This PR does not have translation status info. size/XS Denotes a PR that changes 0-9 lines, ignoring generated files. labels Sep 1, 2026
@coderabbitai

coderabbitai Bot commented Sep 1, 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: Team

Run ID: 3647d065-45cc-4488-b859-ec9964dd05e5

📥 Commits

Reviewing files that changed from the base of the PR and between 6e25fce and bed1403.

📒 Files selected for processing (2)
  • functions-and-operators/tidb-functions.md
  • releases/release-5.2.0.md

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


📝 Walkthrough

Walkthrough

The documentation updates descriptions of TIDB_DECODE_SQL_DIGESTS() in the TiDB function reference and the 5.2.0 release notes. The text clarifies normalized SQL wording and literal placeholders.

Changes

SQL digest documentation

Layer / File(s) Summary
Normalized SQL description wording
functions-and-operators/tidb-functions.md, releases/release-5.2.0.md
The descriptions of TIDB_DECODE_SQL_DIGESTS() now clarify that normalized SQL excludes value formats and arguments. The release note specifies literal placeholders such as ? or ....

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

Merge Risk: ⚪ Minimal · up to bed14

This clarifies normalized SQL wording across the relevant documentation without changing product behavior. The update is ready to merge.

🚥 Pre-merge checks | ✅ 5
✅ Passed checks (5 passed)
Check name Status Explanation
Title check ✅ Passed The title clearly identifies the affected documentation areas and the main wording clarification for TIDB_DECODE_SQL_DIGESTS().
Description check ✅ Passed The description explains the wording change and its translation-related rationale. It includes the required change summary and affected version, plus the remaining template sections. The reference-lin…
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.
Full details: Description check

Explanation

The description explains the wording change and its translation-related rationale. It includes the required change summary and affected version, plus the remaining template sections. The reference-link fields are empty, but they are non-critical for this documentation-only change.

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. (2 skipped: 2 unsupported.)

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

@qiancai qiancai left a comment

Copy link
Copy Markdown
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Rest LGTM

Comment thread functions-and-operators/tidb-functions.md Outdated
Comment thread functions-and-operators/tidb-functions.md Outdated
Comment thread functions-and-operators/tidb-functions.md Outdated
Comment thread releases/release-5.2.0.md Outdated
@ti-chi-bot ti-chi-bot Bot added the needs-1-more-lgtm Indicates a PR needs 1 more LGTM. label Sep 3, 2026
@ti-chi-bot

ti-chi-bot Bot commented Sep 3, 2026

Copy link
Copy Markdown

[LGTM Timeline notifier]

Timeline:

  • 2026-09-03 06:32:55.598802222 +0000 UTC m=+1347410.769896348: ☑️ agreed by qiancai.

@qiancai qiancai self-assigned this Sep 3, 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 needs-1-more-lgtm Indicates a PR needs 1 more LGTM. labels Sep 3, 2026
@ti-chi-bot ti-chi-bot Bot removed the missing-translation-status This PR does not have translation status info. label Sep 3, 2026
yahonda and others added 2 commits September 3, 2026 15:34
Co-authored-by: Grace Cai <qqzczy@126.com>
Co-authored-by: Grace Cai <qqzczy@126.com>
@ti-chi-bot

ti-chi-bot Bot commented Sep 3, 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 ask for approval from qiancai. 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

yahonda and others added 2 commits September 3, 2026 15:35
Co-authored-by: Grace Cai <qqzczy@126.com>
Co-authored-by: Grace Cai <qqzczy@126.com>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

needs-cherry-pick-release-8.5 Should cherry pick this PR to release-8.5 branch. size/XS Denotes a PR that changes 0-9 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.

2 participants