Improve arrow-buffer documentation #9020
Merged
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Jefffrey
approved these changes
Dec 20, 2025
Comment on lines
77
to
79
| offset: usize, | ||
| /// Length in bits (not bytes) | ||
| len: usize, |
Contributor
There was a problem hiding this comment.
Worth renaming the fields themselves to bit_offset and bit_length for further clarity?
Contributor
Author
There was a problem hiding this comment.
Yes I think this is a good idea -- I will do so as a follow on PR
Contributor
Author
There was a problem hiding this comment.
Co-authored-by: Jeffrey Vo <[email protected]>
Co-authored-by: Jeffrey Vo <[email protected]>
Jefffrey
pushed a commit
that referenced
this pull request
Dec 25, 2025
# Which issue does this PR close? - Follow on to #9020 # Rationale for this change @Jefffrey suggested renaming these fields would help make it even more clear that the offset and lengths in `BooleanBuffer` are in terms of bits (not bytes) # What changes are included in this PR? Update field names and improve some more comments # Are these changes tested? # Are there any user-facing changes? No, this is internal field name and documentation changes only I did consider deprecating `BooleanBuffer::len` and renaming it to `BooleanBuffer::bit_len` and similarly for offset, but that seems overly aggressive for downstream consumers (they have to make changes for no obvious benefit 🤔 )
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
2 participants
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Which issue does this PR close?
Rationale for this change
As I study this code, I want to encode my learnings for both my future self and future readers of this code
What changes are included in this PR?
Add documentation on the structure of the arrow buffer crate as well as details on how BooleanBuffer works
Are these changes tested?
CI
Are there any user-facing changes?
Just docs, no functional changes