Skip to content

Conversation

@alamb
Copy link
Contributor

@alamb alamb commented Dec 3, 2025

Which issue does this PR close?

Rationale for this change

When reviewing #8940 it wasn't clear you could create a VariantPath from a string

Thus let's add an example to the documentation

What changes are included in this PR?

Add an example to the documentation

Are these changes tested?

Yes, by CI

Are there any user-facing changes?

Docs only, no functional change

@github-actions github-actions bot added the parquet-variant parquet-variant* crates label Dec 3, 2025
@alamb alamb marked this pull request as ready for review December 3, 2025 17:46
@alamb alamb added the documentation Improvements or additions to documentation label Dec 3, 2025
Copy link
Member

@klion26 klion26 left a comment

Choose a reason for hiding this comment

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

Thanks for the improvement, LGTM

/// assert_eq!(path, path3);
/// ```
///
/// # Example: From Dot notation strings
Copy link
Contributor

Choose a reason for hiding this comment

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

My immediate question from this is "is there an escape mechanism to allow for "." in a field name?". I checked and the answer's no. That's fine but it might be worth a note.

Copy link
Contributor Author

Choose a reason for hiding this comment

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

I'll do even better than that and instead 🎣 for real support:

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

documentation Improvements or additions to documentation parquet-variant parquet-variant* crates

Projects

None yet

Development

Successfully merging this pull request may close these issues.

3 participants