Skip to content

fix(docs): correct the low-level example query - #333

Merged
tokoko merged 2 commits into
mainfrom
fix/readme-low-level-query
Nov 3, 2026
Merged

tokoko merged 2 commits into
mainfrom
fix/readme-low-level-query

Conversation

@benbellick

@benbellick benbellick commented Nov 3, 2026 •

Copy link
Copy Markdown
Member

Match the SQL table name to the people table in the generated plan.

This small correction also enables a patch release containing #315. That protobuf v7 compatibility change was merged as a chore, so semantic-release skipped it, but downstream consumers need it to unblock a grpcio security upgrade.

@coderabbitai

coderabbitai Bot commented Nov 3, 2026 •

Copy link
Copy Markdown

Review in Change Stack →

Warning

Review limit reached

You've used all free OSS reviews for now. Wait for the free limit to reset to keep reviewing this public repository.

Next included review available in 54 minutes.

Check out review usage here.

View limit details

Limit details: You’ve used the included review currently available.

Learn how review limits work.

Review configuration:

Run configuration
Commits

Reviewing files that changed from the base of the PR and between dda0ca1 and 9db47ba.

Files selected for processing: 1
  • README.md

No actionable comments were generated in the recent review.

Summary

Summary by CodeRabbit

  • Documentation
    • Updated the low-level example to describe selecting both first_name and surname from people.

The README example description now says the plan selects both first_name and surname from people.

Changes: README example description

Layer / File(s) Summary
Update query description
README.md
The example description changes from selecting first_name from person to selecting first_name and surname from people.

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

Change: Other

Suggested reviewers: amol-

Merge Risk: Minimal · previous review dda0c

The documentation correction presents no identified merge-blocking risk. The reported patch-release and downstream compatibility benefits are not independently verified.

Pre-merge checks: Passed 4
Check name Status Explanation
Title check Passed The title "fix(docs): correct the low-level example query" is a valid Conventional Commit and matches the single change in the changeset. The README's low-level example query is corrected to select fr…
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.
Description check Passed The description explains the SQL correction and gives the release rationale, including why the protobuf v7 compatibility change matters to downstream consumers.
Full details: Title check

Explanation

The title "fix(docs): correct the low-level example query" is a valid Conventional Commit and matches the single change in the changeset. The README's low-level example query is corrected to select from people the columns first_name and surname, matching the generated plan. The title is specific and accurately describes the primary change.

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

Tip

🎯 Customize your risk assessments

Guide how CodeRabbit assesses merge risk and security architecture risk. Highlight sensitive changes and explain your security boundaries using Merge Risk Instructions and Security Risk Instructions in your review settings. Security architecture risk assessments require the Advanced plan or above.

✅ Automatic approvals, with your rules

Let CodeRabbit approve pull requests once required threads are resolved, pre-merge checks pass, and your risk limits are met. Enable Automatic approvals in review settings, with overrides for teams or file paths.

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

CodeRabbit Verify

  • Run CodeRabbit Verify to test the changes in this pull request.
Recent review info
Run configuration
Commits

Reviewing files that changed from the base of the PR and between 2eb7f59 and dda0ca1.

Files selected for processing: 1
  • README.md

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

@benbellick
benbellick marked this pull request as ready for review November 3, 2026 14:32
@benbellick

Copy link
Copy Markdown
Member Author

@kadinrabo mind taking a look at this one?

@vbarua vbarua left a comment

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

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

Looks good.

While this is not stricly a fix, it's a cheap way to cut a quick patch release. For context, this will let us release a version of substrait-python that updates the grpcio io bounds to enable users to upgrade grpcio to deal with GHSA-2xm2-c8xx-p9vh.

@tokoko
tokoko merged commit 685d575 into main Nov 3, 2026
27 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

4 participants