This is an automated email from the ASF dual-hosted git repository.
brycemecum pushed a commit to branch main
in repository https://gitbox.apache.org/repos/asf/arrow-nanoarrow.git
The following commit(s) were added to refs/heads/main by this push:
new 5b07c2d7 docs: fix issues in ArrowBasicArrayStreamSetArray docstring
(#838)
5b07c2d7 is described below
commit 5b07c2d787fa5f17f4caf7cf39c165a10b417719
Author: Bryce Mecum <[email protected]>
AuthorDate: Tue Jan 13 16:01:26 2026 -0800
docs: fix issues in ArrowBasicArrayStreamSetArray docstring (#838)
This fixes two issues with the docstring for
ArrowBasicArrayStreamSetArray:
1. Corrects a statement about the range of the `i` parameter. The
correct range for `i` is `[0, n_arrays)`. I believe this was just a
mistake as tests (and my code) uses 0 just fine.
2. Fixes a minor grammar issue in "move" vs. "moves"
---
src/nanoarrow/nanoarrow.h | 4 ++--
1 file changed, 2 insertions(+), 2 deletions(-)
diff --git a/src/nanoarrow/nanoarrow.h b/src/nanoarrow/nanoarrow.h
index cfde1452..c22ef12e 100644
--- a/src/nanoarrow/nanoarrow.h
+++ b/src/nanoarrow/nanoarrow.h
@@ -1251,8 +1251,8 @@ NANOARROW_DLL ArrowErrorCode ArrowBasicArrayStreamInit(
/// \brief Set the ith ArrowArray in this ArrowArrayStream.
///
/// array_stream must have been initialized with ArrowBasicArrayStreamInit().
-/// This function move the ownership of array to the array_stream. i must
-/// be greater than zero and less than the value of n_arrays passed in
+/// This function moves the ownership of array to the array_stream. i must
+/// be greater than or equal to zero and less than the value of n_arrays
passed in
/// ArrowBasicArrayStreamInit(). Callers are not required to fill all
/// n_arrays members (i.e., n_arrays is a maximum bound).
NANOARROW_DLL void ArrowBasicArrayStreamSetArray(struct ArrowArrayStream*
array_stream,
