Skip to content

lake: fix broken text and markup in TiDB Cloud Lake docs - #24523

Open
yahonda wants to merge 4 commits into
pingcap:release-8.5from
yahonda:lake-fix-remaining-en-defects
Open

yahonda wants to merge 4 commits into
pingcap:release-8.5from
yahonda:lake-fix-remaining-en-defects

Conversation

@yahonda

@yahonda yahonda commented Oct 22, 2026 •

Copy link
Copy Markdown
Member

What is changed, added or deleted? (Required)

This PR fixes broken text and markup in eight TiDB Cloud Lake pages. The defects were found during a line-by-line review of the Japanese Lake docs: the Japanese pages are translated from these English pages, so they show the same defects.

File Line Before After Why
tidb-cloud-lake/sql/in.md 2, 6 NOT ] IN [ NOT ] IN The opening [ is missing from the title and H1. The TOC entry is already [ NOT ] IN. The title is quoted because a YAML value cannot start with [.
tidb-cloud-lake/sql/cast.md 3 …another. is an alias for CAST. …another. `::` is an alias for CAST. The summary dropped the :: operator, which the body (line 8) has.
tidb-cloud-lake/sql/copy-into-table.md 655, 656 {\"carTypeId":10,\"distance":5860} {\"carTypeId\":10,\"distance\":5860} Some inner quotes were not escaped. The surrounding text says the example uses a backslash as the escape character for the double quotes in the JSON data, and the other keys in the same lines are escaped.
tidb-cloud-lake/sql/create-table.md 360 student*profiles, \_age* `student_profiles`, `age` Broken emphasis markup. The SQL below the text creates the table student_profiles with the virtual column age.
tidb-cloud-lake/sql/sql-dialects-conformance.md 3 SQL2011 SQL:2011 The summary now matches the body (line 8) and the standard's name.
tidb-cloud-lake/sql/copy-into-table.md 654 ```json ```csv The text above the block calls it a CSV file, and each line has three comma-separated fields. Only the third field holds escaped JSON.
tidb-cloud-lake/sql/create-external-table.md 46 set it to "true". set it to `'true'`. The syntax on line 30 defines the value as 'true' | 'false'. The code format and single quotes now match it.
tidb-cloud-lake/sql/refresh-virtual-column.md 24 a table named 'test': a table named `test`: test is a table identifier, not a string literal.
tidb-cloud-lake/sql/split-part.md 53 -- Use ' ' (tab) as the delimiter -- Use ' ' (three spaces) as the delimiter The query on line 55 and its output use three spaces as the delimiter, not a tab.

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

🤖 Generated with Claude Code

Summary by CodeRabbit

  • Documentation
    • Clarified SQL syntax references, including the IN heading and SQL:2011 designation.
    • Corrected example text and formatting for casts, computed columns, virtual-column refreshes, and delimiters.
    • Updated CSV examples to escape quotes in JSON values and corrected the documented quoting for an external-table parameter.

Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
@ti-chi-bot

ti-chi-bot Bot commented Oct 22, 2026

Copy link
Copy Markdown

Skipping CI for Draft Pull Request.
If you want CI signal for your change, please convert it to an actual PR.
You can still manually trigger a test run with /test all

@ti-chi-bot ti-chi-bot Bot added the do-not-merge/work-in-progress Indicates that a PR should not merge because it is a work in progress. label Oct 22, 2026
@coderabbitai

coderabbitai Bot commented Oct 22, 2026 •

Copy link
Copy Markdown

Review in 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
📥 Commits

Reviewing files that changed from the base of the PR and between 5956323 and 920f798.

📒 Files selected for processing: 4
  • tidb-cloud-lake/sql/copy-into-table.md
  • tidb-cloud-lake/sql/create-external-table.md
  • tidb-cloud-lake/sql/refresh-virtual-column.md
  • tidb-cloud-lake/sql/split-part.md

Included review availability: This review used your included allowance. Your plan provides up to 4 included reviews per hour; 0 remain after this review.

📝 Walkthrough

This pull request updates eight LakeSQL documentation passages. The changes correct SQL notation and terminology, adjust code formatting, clarify example descriptions, and escape quotes in sample CSV rows.

Changes: LakeSQL documentation corrections

Layer / File(s) Summary
Correct documentation notation and examples
tidb-cloud-lake/sql/in.md, tidb-cloud-lake/sql/sql-dialects-conformance.md, tidb-cloud-lake/sql/cast.md, tidb-cloud-lake/sql/create-external-table.md, tidb-cloud-lake/sql/create-table.md, tidb-cloud-lake/sql/refresh-virtual-column.md, tidb-cloud-lake/sql/split-part.md, tidb-cloud-lake/sql/copy-into-table.md
Corrected SQL notation and terminology, code formatting, and example descriptions. The CSV sample rows now escape quotes inside their JSON values.

Priority: ⬇️ Low

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

Change: Other

Suggested reviewers: lilin90

Merge Risk: ⚪ Minimal · up to 920f7

No actionable merge-blocking risk remains in these documentation-only corrections.

Pre-merge checks: Passed 5
Check name Status Explanation
Title check Passed The title clearly and concisely describes the primary change: fixing broken text and markup in the TiDB Cloud Lake documentation.
Description check Passed The description explains the changes across all affected files, identifies the target TiDB version, provides reference links, records AI involvement, and addresses the template sections relevant to th…
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 changes across all affected files, identifies the target TiDB version, provides reference links, records AI involvement, and addresses the template sections relevant to this 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. (4 skipped: 4 unsupported.)

✨ Finishing Touches
🧪 Generate unit tests (beta)
  • Create a new PR
  • Autofix · Keep fixing CodeRabbit findings and required CI, and resolving merge conflicts

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.

@ti-chi-bot

ti-chi-bot Bot commented Oct 22, 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 lilin90 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

@ti-chi-bot ti-chi-bot Bot added missing-translation-status This PR does not have translation status info. size/S Denotes a PR that changes 10-29 lines, ignoring generated files. labels Oct 22, 2026
@yahonda
yahonda marked this pull request as ready for review October 22, 2026 01:02
@ti-chi-bot ti-chi-bot Bot removed the do-not-merge/work-in-progress Indicates that a PR should not merge because it is a work in progress. label Oct 22, 2026

@coderabbitai coderabbitai Bot left a comment

Copy link
Copy Markdown

Choose a reason for hiding this comment

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

Actionable comments posted: 1


ℹ️ Review info
⚙️ Run configuration
  • Configuration used: Repository: pingcap/docs/.coderabbit.yaml
  • Review profile: ASSERTIVE
  • Plan: Advanced
  • Run ID: 6a2e8951-d82c-456f-8040-85268cb78edf
📥 Commits

Reviewing files that changed from the base of the PR and between 6e320b1 and 5510494.

📒 Files selected for processing: 6
  • tidb-cloud-lake/guides/connect-using-lakesql.md
  • tidb-cloud-lake/sql/cast.md
  • tidb-cloud-lake/sql/copy-into-table.md
  • tidb-cloud-lake/sql/create-table.md
  • tidb-cloud-lake/sql/in.md
  • tidb-cloud-lake/sql/sql-dialects-conformance.md

Included review availability: This review used your included allowance. Your plan provides up to 4 included reviews per hour; 2 remain after this review.

Comment thread tidb-cloud-lake/guides/connect-using-lakesql.md Outdated
Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
yahonda and others added 2 commits October 23, 2026 10:32
Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

missing-translation-status This PR does not have translation status info. size/S Denotes a PR that changes 10-29 lines, ignoring generated files.

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant