This is an automated email from the ASF dual-hosted git repository.
tustvold 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 cb18801a99 doc: fix IPC file reader/writer docs (#7178)
cb18801a99 is described below
commit cb18801a9943b3de430f4623caf23059566826d9
Author: Jeffrey Vo <[email protected]>
AuthorDate: Tue Feb 25 04:38:13 2025 +1100
doc: fix IPC file reader/writer docs (#7178)
---
arrow-ipc/src/reader.rs | 2 +-
arrow-ipc/src/writer.rs | 4 ++--
2 files changed, 3 insertions(+), 3 deletions(-)
diff --git a/arrow-ipc/src/reader.rs b/arrow-ipc/src/reader.rs
index ca0d09e228..ddda179cbe 100644
--- a/arrow-ipc/src/reader.rs
+++ b/arrow-ipc/src/reader.rs
@@ -1062,7 +1062,7 @@ impl FileReaderBuilder {
/// For an example creating Arrays without copying using memory mapped
(`mmap`)
/// files see the [`zero_copy_ipc`] example.
///
-/// [IPC Streaming Format]:
https://arrow.apache.org/docs/format/Columnar.html#ipc-streaming-format
+/// [IPC File Format]:
https://arrow.apache.org/docs/format/Columnar.html#ipc-file-format
/// [`zero_copy_ipc`]:
https://github.com/apache/arrow-rs/blob/main/arrow/examples/zero_copy_ipc.rs
pub struct FileReader<R> {
/// File reader that supports reading and seeking
diff --git a/arrow-ipc/src/writer.rs b/arrow-ipc/src/writer.rs
index 451b7e02c5..f5ba6b77a8 100644
--- a/arrow-ipc/src/writer.rs
+++ b/arrow-ipc/src/writer.rs
@@ -920,11 +920,11 @@ impl DictionaryTracker {
/// # Example
/// ```
/// # use arrow_array::record_batch;
-/// # use arrow_ipc::writer::StreamWriter;
+/// # use arrow_ipc::writer::FileWriter;
/// # let mut file = vec![]; // mimic a file for the example
/// let batch = record_batch!(("a", Int32, [1, 2, 3])).unwrap();
/// // create a new writer, the schema must be known in advance
-/// let mut writer = StreamWriter::try_new(&mut file,
&batch.schema()).unwrap();
+/// let mut writer = FileWriter::try_new(&mut file, &batch.schema()).unwrap();
/// // write each batch to the underlying writer
/// writer.write(&batch).unwrap();
/// // When all batches are written, call finish to flush all buffers
