Add documentation for poll_next_batch function in PyRecordBatchStream

kosiew · kosiew · commit d8fb6344c7a8 · 2025-09-02T13:56:27.000+08:00
diff --git a/src/record_batch.rs b/src/record_batch.rs
@@ -84,6 +84,7 @@ impl PyRecordBatchStream {
     }
 }
 
+/// Polls the next batch from a `SendableRecordBatchStream`, converting the `Option<Result<_>>` form.
 pub(crate) async fn poll_next_batch(
     stream: &mut SendableRecordBatchStream,
 ) -> datafusion::error::Result<Option<RecordBatch>> {

Original file line number	Diff line number	Diff line change
`@@ -84,6 +84,7 @@ impl PyRecordBatchStream {`
`84`	`84`	`}`
`85`	`85`	`}`
`86`	`86`
	`87`	+/// Polls the next batch from a `SendableRecordBatchStream`, converting the `Option<Result<_>>` form.
`87`	`88`	`pub(crate) async fn poll_next_batch(`
`88`	`89`	`stream: &mut SendableRecordBatchStream,`
`89`	`90`	`) -> datafusion::error::Result<Option<RecordBatch>> {`