Skip to content

Minor: Add doc comments to GenericByteViewArray #5512

New issue

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

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

Already on GitHub? # to your account

Merged
merged 2 commits into from
Mar 15, 2024

Conversation

alamb
Copy link
Contributor

@alamb alamb commented Mar 14, 2024

Which issue does this PR close?

Part of #5374

Rationale for this change

#5481 added this new array type 🙏 @ariesdevil thank you.

It would be good to start making it easier to use with more documentation. Also I was in the middle of filing other tickets and I wanted a diagram to explain "garbage collection" in this context, so I figured I would also make a diagram for the main array types

What changes are included in this PR?

Add doc comments / ascii art to the GenericByteViewArray

Screenshot 2024-03-14 at 2 25 04 PM

Are there any user-facing changes?

Only docs

@alamb alamb added the documentation Improvements or additions to documentation label Mar 14, 2024
@github-actions github-actions bot added the arrow Changes to the arrow crate label Mar 14, 2024
@alamb alamb marked this pull request as ready for review March 15, 2024 00:11
@tustvold tustvold merged commit 5dd5418 into apache:master Mar 15, 2024
@alamb alamb deleted the alamb/array_view_docs branch March 15, 2024 14:24
# for free to join this conversation on GitHub. Already have an account? # to comment
Labels
arrow Changes to the arrow crate documentation Improvements or additions to documentation
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants