This is an automated email from the ASF dual-hosted git repository.
pitrou pushed a commit to branch main
in repository https://gitbox.apache.org/repos/asf/arrow.git
The following commit(s) were added to refs/heads/main by this push:
new 6b4c524812 GH-50172: [Doc][Format] Clarify that variadic buffers can
also be null (#50255)
6b4c524812 is described below
commit 6b4c5248127881c506d4e21e6c95a5c4ced5d0d4
Author: Antoine Pitrou <[email protected]>
AuthorDate: Mon Jun 29 10:49:05 2026 +0200
GH-50172: [Doc][Format] Clarify that variadic buffers can also be null
(#50255)
### Rationale for this change
Some implementations are known to produce null variadic buffers in
BinaryView arrays, and expose them on the C Data Interface.
Since Arrow C++, and perhaps other implementations, make the wrong
assumption that imported variadic buffers cannot be null, clarify the docs.
### Are these changes tested?
N/A.
### Are there any user-facing changes?
No.
* GitHub Issue: #50172
Authored-by: Antoine Pitrou <[email protected]>
Signed-off-by: Antoine Pitrou <[email protected]>
---
docs/source/format/CDataInterface.rst | 3 ++-
1 file changed, 2 insertions(+), 1 deletion(-)
diff --git a/docs/source/format/CDataInterface.rst
b/docs/source/format/CDataInterface.rst
index fd9952b037..0c71b0cd8b 100644
--- a/docs/source/format/CDataInterface.rst
+++ b/docs/source/format/CDataInterface.rst
@@ -491,7 +491,8 @@ It has the following fields:
The buffer pointers MAY be null only in two situations:
1. for the null bitmap buffer, if :c:member:`ArrowArray.null_count` is 0;
- 2. for any buffer, if the size in bytes of the corresponding buffer would
be 0.
+ 2. for any buffer (including variadic buffers), if the size in bytes of the
+ corresponding buffer would be 0.
Buffers of children arrays are not included.
