mbrobbel commented on code in PR #7346:
URL: https://github.com/apache/arrow-rs/pull/7346#discussion_r2018222402
##########
arrow-cast/src/pretty.rs:
##########
@@ -31,21 +31,82 @@ use arrow_schema::ArrowError;
use crate::display::{ArrayFormatter, FormatOptions};
-/// Create a visual representation of record batches
+/// Create a visual representation of [`RecordBatch`]es
+///
+/// Uses default values for display. See [`pretty_format_batches_with_options`]
+/// for more control.
+///
+/// # Example
+/// ```
+/// # use std::sync::Arc;
+/// # use arrow_array::{ArrayRef, Int32Array, RecordBatch, StringArray};
+/// # use arrow_cast::pretty::pretty_format_batches;
+/// # let batch = RecordBatch::try_from_iter(vec![
+/// # ("a", Arc::new(Int32Array::from(vec![1, 2, 3, 4, 5])) as ArrayRef),
+/// # ("b", Arc::new(StringArray::from(vec![Some("a"), Some("b"), None,
Some("d"), Some("e")]))),
+/// # ]).unwrap();
+/// // Note, returned object implements `Display`
+/// let pretty_table = pretty_format_batches(&[batch]).unwrap();
+/// let table_str = format!("Batches:\n{}", pretty_table);
+/// assert_eq!(table_str,
+/// r#"Batches:
+/// +---+---+
+/// | a | b |
+/// +---+---+
+/// | 1 | a |
+/// | 2 | b |
+/// | 3 | |
+/// | 4 | d |
+/// | 5 | e |
+/// +---+---+"#);
+/// ```
pub fn pretty_format_batches(results: &[RecordBatch]) -> Result<impl Display,
ArrowError> {
let options = FormatOptions::default().with_display_error(true);
pretty_format_batches_with_options(results, &options)
}
-/// Create a visual representation of record batches
+/// Create a visual representation of [`RecordBatch`]es with formatting
options.
+///
+/// # Arguments
+/// * `results` - A slice of record batches to display
+/// * `options` - [`FormatOptions`] that control the resulting display
+///
+/// # Example
+/// ```
+/// # use std::sync::Arc;
+/// # use arrow_array::{ArrayRef, Int32Array, RecordBatch, StringArray};
+/// # use arrow_cast::display::FormatOptions;
+/// # use arrow_cast::pretty::{pretty_format_batches,
pretty_format_batches_with_options};
+/// # let batch = RecordBatch::try_from_iter(vec![
+/// # ("a", Arc::new(Int32Array::from(vec![1, 2])) as ArrayRef),
+/// # ("b", Arc::new(StringArray::from(vec![Some("a"), None]))),
+/// # ]).unwrap();
+/// let options = FormatOptions::new()
+/// .with_null("<NULL>");
+/// // Note, returned object implements `Display`
+/// let pretty_table = pretty_format_batches_with_options(&[batch],
&options).unwrap();
+/// let table_str = format!("Batches:\n{}", pretty_table);
Review Comment:
```suggestion
/// let table_str = format!("Batches:\n{pretty_table}");
```
##########
arrow-cast/src/pretty.rs:
##########
@@ -31,21 +31,82 @@ use arrow_schema::ArrowError;
use crate::display::{ArrayFormatter, FormatOptions};
-/// Create a visual representation of record batches
+/// Create a visual representation of [`RecordBatch`]es
+///
+/// Uses default values for display. See [`pretty_format_batches_with_options`]
+/// for more control.
+///
+/// # Example
+/// ```
+/// # use std::sync::Arc;
+/// # use arrow_array::{ArrayRef, Int32Array, RecordBatch, StringArray};
+/// # use arrow_cast::pretty::pretty_format_batches;
+/// # let batch = RecordBatch::try_from_iter(vec![
+/// # ("a", Arc::new(Int32Array::from(vec![1, 2, 3, 4, 5])) as ArrayRef),
+/// # ("b", Arc::new(StringArray::from(vec![Some("a"), Some("b"), None,
Some("d"), Some("e")]))),
+/// # ]).unwrap();
+/// // Note, returned object implements `Display`
+/// let pretty_table = pretty_format_batches(&[batch]).unwrap();
+/// let table_str = format!("Batches:\n{}", pretty_table);
Review Comment:
```suggestion
/// let table_str = format!("Batches:\n{pretty_table}");
```
--
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: github-unsubscr...@arrow.apache.org
For queries about this service, please contact Infrastructure at:
us...@infra.apache.org
