DOC: fix hypothetical Rust code in step_by()
docstring
#87034
Merged
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.
I don't know how important that is, but if I'm not mistaken, the hypothetical code in the docstring of
step_by()
(see https://doc.rust-lang.org/std/iter/trait.Iterator.html#method.step_by) isn't correct.I guess writing
next()
instead ofself.next()
isn't a biggie, but this would also imply thatadvance_n_and_return_first()
is a method, which AFAICT it isn't.I've also done some re-formatting in a separate commit and a parameter renaming in yet another commit.
Feel free to take or leave any combination of those commits.