GH-141: Correct capacity behavior in BufferAllocator.buffer docstrings#1010
Merged
jbonofre merged 1 commit intoapache:mainfrom Feb 8, 2026
Merged
GH-141: Correct capacity behavior in BufferAllocator.buffer docstrings#1010jbonofre merged 1 commit intoapache:mainfrom
jbonofre merged 1 commit intoapache:mainfrom
Conversation
axreldable
requested review from
jbonofre,
laurentgo,
lidavidm and
wgtmac
as code owners
This comment has been minimized.
This comment has been minimized.
Contributor
Author
|
I'm not able to set the |
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
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
3 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.
What's Changed
Update the
BufferAllocator.buffer(long)andBufferAllocator.buffer(long, BufferManager)docstrings so they match the actual behavior: the returned buffer’s capacity is the allocated (possibly rounded) size, not the requested size. The previous text said the capacity would be set to the configured size, which was incorrect. The new text also mentions that callers can useArrowBuf#capacity(long)to set the capacity to the requested size when needed.Documentation-only change; no code or behavioral changes.
Closes #141.