Minor: Add a link to RecordBatchStreamAdapter to `SendableRecordBatch…

…Stream`
alamb · Jan 11, 2025 · 8091076 · 8091076
1 parent 17446ad
commit 8091076
Showing 1 changed file with 7 additions and 0 deletions.
diff --git a/datafusion/execution/src/stream.rs b/datafusion/execution/src/stream.rs
@@ -40,6 +40,13 @@ pub trait RecordBatchStream: Stream<Item = Result<RecordBatch>> {
 /// `RecordBatch` returned by the stream should have the same schema as returned
 /// by [`schema`](`RecordBatchStream::schema`).
 ///
+/// # See Also
+///
+/// * [`RecordBatchStreamAdapter`] to convert an existing [`Stream`]
+///   to [`SendableRecordBatchStream`]
+///
+/// [`RecordBatchStreamAdapter`]: https://docs.rs/datafusion/latest/datafusion/physical_plan/stream/struct.RecordBatchStreamAdapter.html
+///
 /// # Error Handling
 ///
 /// Once a stream returns an error, it should not be polled again (the caller