[Variant] add doc reference to VariantArrayBuilder#10152
Open
sdf-jkl wants to merge 2 commits into
Open
Conversation
alamb
approved these changes
Jun 18, 2026
| /// implements [`VariantBuilderExt`], so you append values and nested objects or | ||
| /// lists the same way: | ||
| /// | ||
| /// ```ignore |
Contributor
There was a problem hiding this 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
/// `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
/// [`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
/// ```
🤔
Contributor
Author
There was a problem hiding this comment.
That makes sense, thanks. I dropped the example because VariantArrayBuilder already has some.
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Which issue does this PR close?
VariantBuilder#9113.Rationale for this change
Users might go for
VariantBuilderto manually buildVariantArrays.Instead they should use
VariantArrayBuilder.What changes are included in this PR?
VariantArrayBuilderforVariantBuilderAre these changes tested?
n/a
Are there any user-facing changes?
doc change