Improve documentation on ArrayData::offset
#7385
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
westonpace
approved these changes
Apr 3, 2025
Member
westonpace
left a comment
westonpace
left a comment
There was a problem hiding this comment.
Minor suggestions but this is overall an improvement.
Co-authored-by: Weston Pace <[email protected]>
Contributor
Author
|
Thank you @westonpace |
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
While reviewing #7366 from @westonpace I found myself confused about what
offsetapplied to (specifically did it apply to theNullBuffertoo) that @westonpace sorted me out: https://github.com/apache/arrow-rs/pull/7366/files#r2026930221However, I would like to be able to more easily find this information in the future
What changes are included in this PR?
Add additional documentation about what
ArrayData::offsetdoes and does not apply toAre there any user-facing changes?
Just docs, no functional changes
Lots of documentation recently 🤔