Skip to content

Commit

Permalink
fix doc links
Browse files Browse the repository at this point in the history
  • Loading branch information
ryan-johnson-databricks committed Feb 7, 2025
1 parent 37dc4d0 commit 0df7e26
Show file tree
Hide file tree
Showing 2 changed files with 5 additions and 4 deletions.
6 changes: 3 additions & 3 deletions arrow-json/src/reader/mod.rs
Original file line number Diff line number Diff line change
Expand Up @@ -625,17 +625,17 @@ impl Decoder {
self.tape_decoder.num_buffered_rows()
}

/// True if there are no records to flush, i.e. [`len`] is zero.
/// True if there are no records to flush, i.e. [`Self::len`] is zero.
pub fn is_empty(&self) -> bool {
self.len() == 0
}

/// Flushes the currently buffered data to a [`RecordBatch`]
///
/// Returns `Ok(None)` if no buffered data, i.e. [`is_empty`] is true.
/// Returns `Ok(None)` if no buffered data, i.e. [`Self::is_empty`] is true.
///
/// Note: This will return an error if called part way through decoding a record,
/// i.e. [`has_partial_record`] is true.
/// i.e. [`Self::has_partial_record`] is true.
pub fn flush(&mut self) -> Result<Option<RecordBatch>, ArrowError> {
let tape = self.tape_decoder.finish()?;

Expand Down
3 changes: 2 additions & 1 deletion arrow-json/src/reader/tape.rs
Original file line number Diff line number Diff line change
Expand Up @@ -550,7 +550,8 @@ impl TapeDecoder {
self.cur_row
}

/// True if the decoder is part way through decoding a row. If so, calling [`finish`] would return an error.
/// True if the decoder is part way through decoding a row. If so, calling [`Self::finish`]
/// would return an error.
pub fn has_partial_row(&self) -> bool {
!self.stack.is_empty()
}
Expand Down

0 comments on commit 0df7e26

Please sign in to comment.