Skip to content

transaction-isolation-levels: fix wording and grammar issues - #23642

Open
yahonda wants to merge 3 commits into
release-8.5from
clarify-transaction-statement-wording
Open

transaction-isolation-levels: fix wording and grammar issues#23642
yahonda wants to merge 3 commits into
release-8.5from
clarify-transaction-statement-wording

Conversation

@yahonda

@yahonda yahonda commented Aug 28, 2026

Copy link
Copy Markdown
Member

What is changed, added or deleted? (Required)

Two EN clarity/grammar issues found while reviewing a Japanese translation of this file:

1. Ambiguous "the transaction statement" wording

The Repeatable Read section says "the transaction statement does see the effects of previous updates executed within its own transaction" — the definite noun phrase "the transaction statement" reads as if it names a specific category of statement, when the actual meaning is that a statement running within a transaction can see the effects of earlier statements in that SAME transaction (contrasted with not seeing other transactions' uncommitted or concurrently-committed changes).

Confirmed against the Chinese source (docs-cn's corresponding sentence): "对于本事务而言,事务语句可以看到之前的语句做出的修改" — literally "as far as this [own] transaction is concerned, statements [in it] can see the modifications made by previous statements". The Chinese explicitly contrasts "本事务" (this own transaction) against the earlier-mentioned "其他事务" (other transactions); the EN translation dropped that contrast, leaving an ambiguous definite noun phrase.

Reworded to make the "within its own transaction" contrast explicit:

However, within its own transaction, a statement does see the effects of updates made by previous statements in that transaction, even though those updates are not yet committed.

2. Subject-verb agreement error

"though they sharing the same name" is not a grammatical clause (a gerund cannot follow the subject "they" as the main verb). Fixed to "though they share the same name", and added the missing article before "ANSI Repeatable Read isolation level" for consistency with its other mention later in the same paragraph.

Verified against the Chinese source that the surrounding translation itself is accurate (docs-cn: "尽管名称是可重复读隔离级别,但是 TiDB 中可重复读隔离级别和 ANSI 可重复隔离级别是不同的") — only the EN grammar needed fixing, not the meaning.

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

  • 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)?

  • This PR is translated from:
  • Other reference link(s): found while reviewing a Japanese translation of this file, pingcap/docs#23639

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 Repeatable Read transaction behavior, including visibility of earlier statements’ effects and uncommitted updates within the same transaction.
    • Corrected a grammar issue in the comparison between TiDB and ANSI Repeatable Read semantics.

@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 Aug 28, 2026
@coderabbitai

coderabbitai Bot commented Aug 28, 2026

Copy link
Copy Markdown

Review Change Stack

Note

Reviews paused

It looks like this branch is under active development. To avoid overwhelming you with review comments due to an influx of new commits, CodeRabbit has automatically paused this review. You can configure this behavior by changing the reviews.auto_review.auto_pause_after_reviewed_commits setting.

Use the following commands to manage reviews:

  • @coderabbitai resume to resume automatic reviews.
  • @coderabbitai review to trigger a single review.

Use the checkboxes below for quick actions:

  • ▶️ Resume reviews
  • 🔍 Trigger review

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: 200dd829-bd96-4821-8d49-d6ef23baea38

📥 Commits

Reviewing files that changed from the base of the PR and between 288e32b and 8414a37.

📒 Files selected for processing (1)
  • transaction-isolation-levels.md

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


📝 Walkthrough

Walkthrough

The Repeatable Read documentation clarifies statement visibility after earlier updates in the same transaction and corrects grammar in the TiDB comparison.

Changes

Transaction Isolation Documentation

Layer / File(s) Summary
Clarify Repeatable Read documentation
transaction-isolation-levels.md
The documentation clarifies visibility of earlier updates, including uncommitted updates, and corrects the ANSI Repeatable Read comparison.

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

Merge Risk: ⚪ Minimal · up to 8414a

This documentation update clarifies visibility of a transaction’s own uncommitted updates and corrects grammar without changing TiDB behavior or introducing current merge risk.

🚥 Pre-merge checks | ✅ 5
✅ Passed checks (5 passed)
Check name Status Explanation
Description check ✅ Passed The description identifies the two wording and grammar fixes, explains the rationale, specifies the affected TiDB version, provides a related PR, and records AI involvement. The required information i…
Title check ✅ Passed The title clearly and concisely describes the main changes: wording and grammar fixes in transaction isolation documentation.
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 identifies the two wording and grammar fixes, explains the rationale, specifies the affected TiDB version, provides a related PR, and records AI involvement. The required information is complete.

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

✨ Finishing Touches
🧪 Generate unit tests (beta)
  • Create PR with unit tests
  • Commit unit tests in branch clarify-transaction-statement-wording

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.

@yahonda yahonda changed the title transaction-isolation-levels: clarify ambiguous transaction statement wording transaction-isolation-levels: fix wording and grammar issues Aug 28, 2026
…ement" wording

"The transaction statement" reads as if it names a specific category
of statement, when the intended meaning (confirmed against the
Chinese source, docs-cn's "对于本事务而言,事务语句可以看到之前的语句
做出的修改") is that a statement within a transaction can see the
effects of earlier statements in that SAME transaction, contrasted
with not seeing other transactions' uncommitted or concurrent
changes. Rewords to make the "within its own transaction" contrast
explicit.
"though they sharing the same name" is not a grammatical clause (a
gerund cannot follow the subject "they" as the main verb). Fixed to
"though they share the same name", and added the missing article
before "ANSI Repeatable Read isolation level" for consistency with
its other mention later in the same paragraph.

Verified against the Chinese source that the surrounding translation
itself is accurate (docs-cn: "尽管名称是可重复读隔离级别,但是 TiDB
中可重复读隔离级别和 ANSI 可重复隔离级别是不同的") — only the EN
grammar needed fixing, not the meaning.
@yahonda
yahonda force-pushed the clarify-transaction-statement-wording branch from 288e32b to 67cb22b Compare September 2, 2026 02:46

@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 transaction-isolation-levels.md Outdated
@qiancai qiancai self-assigned this Sep 3, 2026
@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 04:08:22.154225277 +0000 UTC m=+1338737.325319390: ☑️ agreed by qiancai.

@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
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

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