Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

docs: add to bit slice iterator docs that the start value is inclusive and end value is exclusive #7022

Merged
merged 1 commit into from
Jan 27, 2025

Conversation

rluvaton
Copy link
Contributor

Which issue does this PR close?

N/A

Rationale for this change

When working on apache/datafusion#14299 I had to look through the code to understand if the end is exclusive or not

Are there any user-facing changes?

only docs

@github-actions github-actions bot added the arrow Changes to the arrow crate label Jan 25, 2025
@alamb alamb added the documentation Improvements or additions to documentation label Jan 27, 2025
Copy link
Contributor

@alamb alamb left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

😍 -- thank you @rluvaton 📖

@@ -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)
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

💯

I double checked and this looks good. Thanks @rluvaton

type Item = (usize, usize);

@alamb alamb merged commit a28f4ef into apache:main Jan 27, 2025
26 checks passed
@rluvaton rluvaton deleted the add-docs branch January 27, 2025 17:56
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
arrow Changes to the arrow crate documentation Improvements or additions to documentation
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants