Skip to content

Commit 30ad86b

Browse files
committed
fix docs
1 parent 7f9e29e commit 30ad86b

File tree

2 files changed

+9
-3
lines changed

2 files changed

+9
-3
lines changed

parquet-variant-compute/src/lib.rs

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -22,7 +22,7 @@ mod variant_array_builder;
2222
pub mod variant_get;
2323

2424
pub use variant_array::VariantArray;
25-
pub use variant_array_builder::VariantArrayBuilder;
25+
pub use variant_array_builder::{VariantArrayBuilder, VariantArrayVariantBuilder};
2626

2727
pub use from_json::batch_json_string_to_variant;
2828
pub use to_json::batch_variant_to_json_string;

parquet-variant-json/src/from_json.rs

Lines changed: 8 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -21,19 +21,25 @@ use arrow_schema::ArrowError;
2121
use parquet_variant::{ListBuilder, ObjectBuilder, Variant, VariantBuilderExt};
2222
use serde_json::{Number, Value};
2323

24-
/// Converts a JSON string to Variant using [`VariantBuilder`]. The resulting `value` and `metadata`
25-
/// buffers can be extracted using `builder.finish()`
24+
/// Converts a JSON string to Variant to a [`VariantBuilderExt`], such as
25+
/// [`VariantBuilder`].
26+
///
27+
/// The resulting `value` and `metadata` buffers can be
28+
/// extracted using `builder.finish()`
2629
///
2730
/// # Arguments
2831
/// * `json` - The JSON string to parse as Variant.
2932
/// * `variant_builder` - Object of type `VariantBuilder` used to build the vatiant from the JSON
3033
/// string
3134
///
35+
///
3236
/// # Returns
3337
///
3438
/// * `Ok(())` if successful
3539
/// * `Err` with error details if the conversion fails
3640
///
41+
/// [`VariantBuilder`]: parquet_variant::VariantBuilder
42+
///
3743
/// ```rust
3844
/// # use parquet_variant::VariantBuilder;
3945
/// # use parquet_variant_json::{

0 commit comments

Comments
 (0)