alamb commented on code in PR #10152:
URL: https://github.com/apache/arrow-rs/pull/10152#discussion_r3438523635
##########
parquet-variant/src/builder.rs:
##########
@@ -477,6 +477,25 @@ impl<S: BuilderSpecificState> Drop for ParentState<'_, S> {
/// Top level builder for [`Variant`] values
///
+/// `VariantBuilder` builds a single, self-contained [`Variant`] value --
useful
+/// for one-off values and unit tests. To build an array (column) of variants,
+/// one per input row, use [`VariantArrayBuilder`] from the
+/// `parquet-variant-compute` crate rather than a `VariantBuilder` per row. It
+/// implements [`VariantBuilderExt`], so you append values and nested objects
or
+/// lists the same way:
+///
+/// ```ignore
Review Comment:
I believe this is marked as ignore as the VariantArrayBuilder lives in a
different crate
It seems like it would be better to not ignore this doc so that it was
tested and we ensure it is a complete example.
What do you think about leaving the text above
```rust
/// `VariantBuilder` builds a single, self-contained [`Variant`] value --
useful
/// for one-off values and unit tests. To build an array (column) of
variants,
/// one per input row, use [`VariantArrayBuilder`] from the
/// `parquet-variant-compute` crate rather than a `VariantBuilder` per row.
```
In this crate
And then adding the example and detail about `VariantBuilderExt` directly as
an exampel on `VariantArrayBuilder` - that would likely make it easier to find
```rust
/// [`VariantArrayBuilder`] implements [`VariantBuilderExt`], so you append
values and
/// nested objects or lists the same way as when building a single Variant
value with [`VariantBuilder`]:
///
/// ```
/// <real example ehre
/// ```
```
🤔
--
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]
