This is an automated email from the ASF dual-hosted git repository.
alamb pushed a commit to branch main
in repository https://gitbox.apache.org/repos/asf/arrow-rs.git
The following commit(s) were added to refs/heads/main by this push:
new a28f4ef585 docs: add to bit slice iterator docs that the start value
is inclusive and end value is exclusive (#7022)
a28f4ef585 is described below
commit a28f4ef5859e5f619f375bd96fafbade16641e5b
Author: Raz Luvaton <[email protected]>
AuthorDate: Mon Jan 27 14:16:21 2025 +0200
docs: add to bit slice iterator docs that the start value is inclusive and
end value is exclusive (#7022)
---
arrow-buffer/src/util/bit_iterator.rs | 2 ++
1 file changed, 2 insertions(+)
diff --git a/arrow-buffer/src/util/bit_iterator.rs
b/arrow-buffer/src/util/bit_iterator.rs
index f667ab1e7b..c3e72044bf 100644
--- a/arrow-buffer/src/util/bit_iterator.rs
+++ b/arrow-buffer/src/util/bit_iterator.rs
@@ -93,6 +93,8 @@ impl DoubleEndedIterator for BitIterator<'_> {
/// Returns `(usize, usize)` each representing an interval where the
corresponding
/// bits in the provides mask are set
///
+/// the first value is the start of the range (inclusive) and the second value
is the end of the range (exclusive)
+///
#[derive(Debug)]
pub struct BitSliceIterator<'a> {
iter: UnalignedBitChunkIterator<'a>,
