alamb commented on code in PR #8532:
URL: https://github.com/apache/arrow-rs/pull/8532#discussion_r2395984704
##########
parquet-variant-compute/src/lib.rs:
##########
@@ -20,10 +20,14 @@
//! ## Main APIs
//! - [`VariantArray`] : Represents an array of `Variant` values.
//! - [`VariantArrayBuilder`]: For building [`VariantArray`]
-//! - [`json_to_variant`]: Function to convert a batch of JSON strings to a
`VariantArray`.
-//! - [`variant_to_json`]: Function to convert a `VariantArray` to a batch of
JSON strings.
-//! - [`mod@cast_to_variant`]: Module to cast other Arrow arrays to
`VariantArray`.
-//! - [`variant_get`]: Module to get values from a `VariantArray` using a
specified [`VariantPath`]
+//!
+//! # Compute Kernels
+//! - [`json_to_variant`]: Function to convert a Arrays of JSON strings to a
`VariantArray`.
+//! - [`variant_to_json`]: Function to convert a `VariantArray` to Arrays of
JSON strings.
+//! - [`cast_to_variant`]: Cast Arrow arrays to `VariantArray`.
+//! - [`variant_get`]: Convert `VariantArray` (or an inner path) to
ArrowArrays type
+//! - [`shred_variant`]: Shred a `VariantArray`
Review Comment:
added mention of shred and unshred
##########
parquet-variant-compute/src/cast.rs:
##########
@@ -34,7 +34,7 @@ use arrow_schema::ArrowError;
/// ```
/// # use arrow::array::{Array, ArrayRef, Int64Array};
/// # use parquet_variant::Variant;
-/// # use parquet_variant_compute::cast_to_variant::cast_to_variant;
+/// # use parquet_variant_compute::cast::cast_to_variant;
Review Comment:
I renamed this module `cast` so that it doesn't have the same name as the
function `cast_to_variant`
##########
parquet-variant-compute/src/lib.rs:
##########
@@ -36,23 +40,24 @@
//! [Variant issue]: https://github.com/apache/arrow-rs/issues/6736
mod arrow_to_variant;
-pub mod cast_to_variant;
+mod cast;
Review Comment:
let's keep it consistent and not have `pub` modules, and instead `pub use`
the parts of the API explicitly
--
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]
