From 09d2cb3cdb9080b378ae6fd0fc9e070bc7b5480a Mon Sep 17 00:00:00 2001
From: Raz Luvaton <16746759+rluvaton@users.noreply.github.com>
Date: Sat, 25 Jan 2025 21:49:31 +0200
Subject: [PATCH] docs: add to bit slice iterator docs that the start value is
 inclusive and end value is exclusive

---
 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 f667ab1e7b9d..c3e72044bf87 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>,