Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Minor: Fix ArrayDataBuilder::build_unchecked docs #7103

Merged
merged 1 commit into from
Feb 10, 2025
Merged

Conversation

gstvg
Copy link
Contributor

@gstvg gstvg commented Feb 9, 2025

Which issue does this PR close?

Rationale for this change

What changes are included in this PR?

Are there any user-facing changes?

Docs only

@github-actions github-actions bot added the arrow Changes to the arrow crate label Feb 9, 2025
Copy link
Contributor

@Jefffrey Jefffrey left a comment

Choose a reason for hiding this comment

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

Thanks 👍

@@ -1929,7 +1929,7 @@ impl ArrayDataBuilder {

/// Creates an array data, without any validation
///
/// Note: This is shorthand for `self.with_skip_validation(true).build()`
/// Note: This is shorthand for `self.skip_validation(true).build().unwrap()`
Copy link
Contributor

Choose a reason for hiding this comment

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

Thoughts on making it a doctest so we catch it via tests?

Copy link
Contributor

Choose a reason for hiding this comment

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

That would be great! Perhaps as a follow on PR

Copy link
Contributor

Choose a reason for hiding this comment

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

@gstvg any chance you have some time to make a PR with a doc example?

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 opened #7139 to make it a doctest

@alamb alamb merged commit 6c1d8c3 into apache:main Feb 10, 2025
26 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
arrow Changes to the arrow crate
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants