This is an automated email from the ASF dual-hosted git repository.
Jefffrey 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 73595d5875 Simplify homogeneous VariantArray doctest fixtures (#11320)
73595d5875 is described below
commit 73595d587538a24dfd5b7025a78d62a555ee5d1c
Author: Jabrail <[email protected]>
AuthorDate: Thu Oct 1 19:26:35 2026 -0700
Simplify homogeneous VariantArray doctest fixtures (#11320)
### Which issue does this PR close?
Follow-up to #11053 and the maintainer discussion there. Related to
#8628.
### Rationale for this change
The `FromIterator<Option<T>>` API merged in #11053 accepts homogeneous
inputs directly. Five `VariantArray` doctest examples still construct a
one-element string array with a mutable builder and explicit
`Variant::from` conversion.
### What changes are included in this PR?
Use `VariantArray::from_iter([Some("such wow")])` in these five examples
and remove imports made unnecessary by the simpler fixture. The example
assertions and resulting values are preserved.
### Are these changes tested?
- `cargo +stable fmt --all -- --check`: passed.
- `cargo +stable test -p parquet-variant-compute`: **369 unit tests and
15 doctests passed**.
- Linux x86_64, Rust 1.98.1 stable.
### Are there any user-facing changes?
The documentation examples are simpler. There are no runtime or API
changes.
Signed-off-by: jabrailkhalil <[email protected]>
---
parquet-variant-compute/src/variant_array.rs | 34 ++++++++--------------------
1 file changed, 10 insertions(+), 24 deletions(-)
diff --git a/parquet-variant-compute/src/variant_array.rs
b/parquet-variant-compute/src/variant_array.rs
index 46cb2abb4f..cdf3436f31 100644
--- a/parquet-variant-compute/src/variant_array.rs
+++ b/parquet-variant-compute/src/variant_array.rs
@@ -225,12 +225,9 @@ impl ExtensionType for VariantType {
/// ```
/// # use arrow::array::StructArray;
/// # use arrow_schema::{Schema, Field, DataType};
-/// # use parquet_variant::Variant;
-/// # use parquet_variant_compute::{VariantArrayBuilder, VariantArray,
VariantType};
+/// # use parquet_variant_compute::{VariantArray, VariantType};
/// # fn get_variant_array() -> VariantArray {
-/// # let mut builder = VariantArrayBuilder::new(10);
-/// # builder.append_variant(Variant::from("such wow"));
-/// # builder.build()
+/// # VariantArray::from_iter([Some("such wow")])
/// # }
/// # fn get_schema() -> Schema {
/// # Schema::new(vec![
@@ -253,12 +250,9 @@ impl ExtensionType for VariantType {
///
/// ```
/// # use arrow_schema::{Schema, Field, DataType};
-/// # use parquet_variant::Variant;
-/// # use parquet_variant_compute::{VariantArrayBuilder, VariantArray,
VariantType};
+/// # use parquet_variant_compute::{VariantArray, VariantType};
/// # fn get_variant_array() -> VariantArray {
-/// # let mut builder = VariantArrayBuilder::new(10);
-/// # builder.append_variant(Variant::from("such wow"));
-/// # builder.build()
+/// # VariantArray::from_iter([Some("such wow")])
/// # }
/// let variant_array = get_variant_array();
/// // First field is an integer id, second field is a variant
@@ -273,12 +267,9 @@ impl ExtensionType for VariantType {
///
/// ```
/// # use arrow_schema::{Schema, Field, DataType};
-/// # use parquet_variant::Variant;
-/// # use parquet_variant_compute::{VariantArrayBuilder, VariantArray,
VariantType};
+/// # use parquet_variant_compute::{VariantArray, VariantType};
/// # fn get_variant_array() -> VariantArray {
-/// # let mut builder = VariantArrayBuilder::new(10);
-/// # builder.append_variant(Variant::from("such wow"));
-/// # builder.build()
+/// # VariantArray::from_iter([Some("such wow")])
/// # }
/// # let variant_array = get_variant_array();
/// // The DataType of a VariantArray varies depending on how it is shredded
@@ -296,12 +287,9 @@ impl ExtensionType for VariantType {
///
/// ```
/// # use arrow::array::StructArray;
-/// # use parquet_variant::Variant;
-/// # use parquet_variant_compute::VariantArrayBuilder;
+/// # use parquet_variant_compute::VariantArray;
/// // Create Variant Array
-/// let mut builder = VariantArrayBuilder::new(10);
-/// builder.append_variant(Variant::from("such wow"));
-/// let variant_array = builder.build();
+/// let variant_array = VariantArray::from_iter([Some("such wow")]);
/// // convert to StructArray
/// let struct_array: StructArray = variant_array.into();
/// ```
@@ -311,11 +299,9 @@ impl ExtensionType for VariantType {
/// ```
/// # use arrow::array::StructArray;
/// # use parquet_variant::Variant;
-/// # use parquet_variant_compute::{VariantArrayBuilder, VariantArray};
+/// # use parquet_variant_compute::VariantArray;
/// # fn get_struct_array() -> StructArray {
-/// # let mut builder = VariantArrayBuilder::new(10);
-/// # builder.append_variant(Variant::from("such wow"));
-/// # builder.build().into()
+/// # VariantArray::from_iter([Some("such wow")]).into()
/// # }
/// let struct_array: StructArray = get_struct_array();
/// // try and create a VariantArray from it
