This is an automated email from the ASF dual-hosted git repository.
alamb pushed a commit to branch main
in repository https://gitbox.apache.org/repos/asf/arrow-rs.git
The following commit(s) were added to refs/heads/main by this push:
new 964805f5eb Update docstring comment for Writer::write() in writer.rs
(#8267)
964805f5eb is described below
commit 964805f5eba808a65ddf904d15bec03250160bc9
Author: Koustubh Rao <88176320+ykoustubh...@users.noreply.github.com>
AuthorDate: Sat Sep 6 15:43:03 2025 +0530
Update docstring comment for Writer::write() in writer.rs (#8267)
# Rationale for this change
Update the docstring from function write() in struct Writer to reflect
that we write only one RecordBatch at a time as opposed to a vector of
record batches.
# What changes are included in this PR?
Just the comment doc string as above
# Are these changes tested?
yes
# Are there any user-facing changes?
No
---------
Co-authored-by: Andrew Lamb <and...@nerdnetworks.org>
Co-authored-by: Matthijs Brobbel <m1brob...@gmail.com>
---
arrow-csv/src/writer.rs | 2 +-
1 file changed, 1 insertion(+), 1 deletion(-)
diff --git a/arrow-csv/src/writer.rs b/arrow-csv/src/writer.rs
index c2cb38a226..e10943a6a9 100644
--- a/arrow-csv/src/writer.rs
+++ b/arrow-csv/src/writer.rs
@@ -102,7 +102,7 @@ impl<W: Write> Writer<W> {
WriterBuilder::new().with_delimiter(delimiter).build(writer)
}
- /// Write a vector of record batches to a writable object
+ /// Write a RecordBatch to a writable object
pub fn write(&mut self, batch: &RecordBatch) -> Result<(), ArrowError> {
let num_columns = batch.num_columns();
if self.beginning {
