V0ldek commented on code in PR #6132:
URL: https://github.com/apache/arrow-rs/pull/6132#discussion_r1693982396
##########
arrow-ipc/src/writer.rs:
##########
@@ -990,16 +998,20 @@ impl<W: Write> FileWriter<W> {
Ok(())
}
- /// Unwraps the BufWriter housed in FileWriter.writer, returning the
underlying
- /// writer
+ /// Unwraps the the underlying writer.
+ ///
+ /// The writer is flushed and the FileWriter is finished before returning.
///
- /// The buffer is flushed and the FileWriter is finished before returning
the
- /// writer.
+ /// # Errors
+ ///
+ /// An ['Err'](Result::Err) may be returned if an error occurs while
finishing the StreamWriter
Review Comment:
I'm going to add those Errors sections to the `try_new*` functions as well
in hindisght.
--
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
To unsubscribe, e-mail: [email protected]
For queries about this service, please contact Infrastructure at:
[email protected]
