docs: fix incorrect max length in take_while example#101
Merged
atulkhare4096 merged 1 commit intoMay 1, 2026
Conversation
|
Cool |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
3 participants
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Description
This PR corrects a minor inaccuracy in the "Scoped mutability" sidebar regarding the maximum number of elements produced by the iterator chain example.
Why?
The text currently claims that the iterator chain
take(10).take_while(...)produces "anywhere from zero to nine elements".However, if the predicate
random::<u8>() % 3 != 0evaluates totruefor all 10 consecutive elements provided bytake(10), the resulting collection will contain exactly 10 elements. Thus, the actual range is 0 to 10, not 0 to 9.The core argument of the paragraph remains perfectly valid: the iterator version can yield 0 elements (failing the "guaranteed-at-least-one" trait of the imperative version). This PR just fixes the understated upper bound.
Changes Made
Updated the text from "zero to nine elements" to "zero to ten elements" to accurately reflect the iterator's potential output.