Improve first() documentation for split iterators
#22374
Conversation
This file contains 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
xdBronch
reviewed
Dec 31, 2024
lib/std/mem.zig
Outdated
| /// Call this only to get the first window and then use `next` to get | ||
| /// all subsequent windows. | ||
| /// If called after iteration has begun, it will panic. |
There was a problem hiding this comment.
an assertion doesnt inherently mean a panic occurs, its just a case of safety-checked undefined behavior. i think this (and the others) should say something more along the lines of Asserts that iteration has not begun, there are many cases of such phrasing across the stdlib
There was a problem hiding this comment.
you're absolutely right, I will change it to follow the docs convention for these cases
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
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.
Remove misleading
This never fails.statement and add explicit clarificationthat first() will panic if called after iteration has already begun.
Fixes #22338