DOC: fix hypothetical Rust code in step_by() docstring
#87034
Merged
Conversation
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
|
r? @kennytm (rust-highfive has picked a reviewer for you, use r? to override) |
rust-highfive
added
the
S-waiting-on-review
|
I guess it's simplified but agree that the proposed change is more accurate. Could you squash commits into one? They're trivial. |
JohnTitor
added
S-waiting-on-author
Done. |
JohnTitor
approved these changes
Jul 23, 2021
|
Sorry for the delay, thanks for the PR! |
|
📌 Commit 46abc12 has been approved by |
bors
added
S-waiting-on-bors
bors
added a commit
to rust-lang-ci/rust
that referenced
this pull request
Jul 23, 2021
Rollup of 8 pull requests Successful merges: - rust-lang#87034 (DOC: fix hypothetical Rust code in `step_by()` docstring) - rust-lang#87298 (memorialize Anna Harren in the bastion of the turbofish) - rust-lang#87332 (Don't hide fields of enum struct variants) - rust-lang#87362 (Make `x.py d` an alias for `x.py doc`) - rust-lang#87372 (Move calls to test_main into one function) - rust-lang#87373 (Extend HIR WF checking to fields) - rust-lang#87376 (Change rustdoc logo to use the full container size) - rust-lang#87383 (Add regression tests for the impl_trait_in_bindings ICEs) Failed merges: r? `@ghost` `@rustbot` modify labels: rollup
# for free
to join this conversation on GitHub.
Already have an account?
# 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.
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.