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: Add docs for GenericBinaryBuilder, links to GenericStringBuilder #5597

Merged
merged 2 commits into from
Apr 9, 2024

Conversation

alamb
Copy link
Contributor

@alamb alamb commented Apr 6, 2024

Which issue does this PR close?

N/A

Rationale for this change

While working on apache/datafusion#9973 with @kevinmingtarja I couldn't immediately find the examples for GenericStringBuilder because it the typedef is expanded out

Screenshot 2024-04-06 at 7 04 12 AM

What changes are included in this PR?

  1. Add doc links to the examples
  2. Add an example for GenericBinaryBuilder for symmetry

Are there any user-facing changes?

Better docs

@github-actions github-actions bot added the arrow Changes to the arrow crate label Apr 6, 2024
@@ -257,6 +261,26 @@ impl<O: OffsetSizeTrait> Write for GenericStringBuilder<O> {
}

/// Array builder for [`GenericBinaryArray`][crate::GenericBinaryArray]
///
/// Values can be appended using [`GenericByteBuilder::append_value`], and nulls with
Copy link
Contributor Author

Choose a reason for hiding this comment

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

this was a drive by cleanup to add an example for symmetry with GenericStringBuilder

@tustvold tustvold merged commit 1852c33 into apache:master Apr 9, 2024
25 checks passed
@alamb alamb deleted the alamb/string_builder_docs branch April 9, 2024 11:13
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.

2 participants