Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Minor: Add a link to RecordBatchStreamAdapter to SendableRecordBatchStream #14084

Merged
merged 1 commit into from
Jan 13, 2025

Conversation

alamb
Copy link
Contributor

@alamb alamb commented Jan 11, 2025

Which issue does this PR close?

Rationale for this change

Streams are hard enough to work with, let's document them the best we can

I often forget what the name of the class that can make a Stream into a RecordBatchStream so let's add that to the docs

What changes are included in this PR?

  1. Add a link to RecordBatchStreamAdapter to SendableRecordBatchStream

Are these changes tested?

CI

Are there any user-facing changes?

more docs, no functional changes

@alamb alamb added the documentation Improvements or additions to documentation label Jan 11, 2025
@github-actions github-actions bot added execution Related to the execution crate and removed documentation Improvements or additions to documentation labels Jan 11, 2025
Copy link
Member

@jonahgao jonahgao left a comment

Choose a reason for hiding this comment

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

LGTM, thanks @alamb

@jonahgao jonahgao merged commit f9cc332 into apache:main Jan 13, 2025
25 checks passed
@alamb alamb deleted the alamb/adapter_docs branch January 13, 2025 17:23
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
execution Related to the execution crate
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants