Skip to content

chore: update README and api docs#296

Merged
lxy-9602 merged 2 commits into
mainfrom
zjw1111-patch-1
May 21, 2026
Merged

chore: update README and api docs#296
lxy-9602 merged 2 commits into
mainfrom
zjw1111-patch-1

Conversation

@zjw1111
Copy link
Copy Markdown
Collaborator

@zjw1111 zjw1111 commented May 21, 2026

Purpose

Linked issue: close #xxx

Tests

API and Format

Documentation

Generative AI tooling

Copilot AI review requested due to automatic review settings May 21, 2026 06:55
Copy link
Copy Markdown

Copilot AI left a comment

Choose a reason for hiding this comment

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

Pull request overview

Note

Copilot was unable to run its full agentic suite in this review.

Updates the README examples to match updated C++ APIs (ownership semantics for RecordBatch and the ReadContextBuilder constructor).

Changes:

  • Update write example to use std::unique_ptr<RecordBatch> and move ownership into Write(...).
  • Update read example to construct ReadContextBuilder without an explicit schema_id.

💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.

Comment thread README.md
Comment thread README.md
@zjw1111 zjw1111 changed the title chore: update examples in README.md chore: update README and api docs May 21, 2026
Copy link
Copy Markdown
Collaborator

@lxy-9602 lxy-9602 left a comment

Choose a reason for hiding this comment

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

+1

@lxy-9602 lxy-9602 merged commit 4e582cb into main May 21, 2026
19 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.

3 participants