docs: add to bit slice iterator docs that the start value is inclusiv…

…e and end value is exclusive
apache · Jan 25, 2025 · 09d2cb3 · 09d2cb3
1 parent af777cd
commit 09d2cb3
Showing 1 changed file with 2 additions and 0 deletions.
diff --git 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>,