Skip to content

Conversation

@alamb
Copy link

@alamb alamb commented Jun 13, 2025

This is a suggestion for the kind of documentation and tests that would be nice for VariantBuilder

Note this PR is in @PinkCrow007 's repository, so if it is merged it will directly update the apache#7653 PR in the arrow repo

/// # Example: Create an Object
/// This example shows how to create an object with two fields:
/// ```json
/// {
Copy link
Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

@PinkCrow007 I hope you don't mind this reference, but I think it is nice to leave some sort of personal legacy in code / examples. Your name will live on whenever someone uses this code / sees these docs

/// },
/// {
/// "first_name": "Malthe",
/// "last_name": "Karbo"
Copy link
Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

fyi @mkarbo

/// let Variant::Object(variant_object) = variant else {
/// panic!("unexpected variant type")
/// };
/// /* TODO: uncomment this, but now VariantObject:field is not implemented
Copy link
Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

@PinkCrow007 PinkCrow007 merged commit 044e4f5 into PinkCrow007:variant-builder Jun 14, 2025
1 check failed
@PinkCrow007
Copy link
Owner

Thanks so much @alamb! I really appreciate the time and care you put into the documentation and examples!! I’m super grateful for your help and support!

@alamb alamb deleted the alamb/variant_builder_docs branch June 16, 2025 10:24
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants