Clarified the documentation on core::iter::from_fn and core::iter::successors
#135118
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
rustbot
added
S-waiting-on-review
tgross35
reviewed
Jan 5, 2025
ranger-ross
force-pushed
the
better-docs-on-iter-fns
branch
from
fc51ac6 to
76ae7ab
Compare
Urgau
requested changes
Jan 5, 2025
ranger-ross
force-pushed
the
better-docs-on-iter-fns
branch
from
76ae7ab to
6243c0f
Compare
|
@bors r+ rollup |
bors
added
S-waiting-on-bors
bors
added a commit
to rust-lang-ci/rust
that referenced
this pull request
Jan 6, 2025
Rollup of 3 pull requests Successful merges: - rust-lang#135115 (cg_llvm: Use constants for DWARF opcodes, instead of FFI calls) - rust-lang#135118 (Clarified the documentation on `core::iter::from_fn` and `core::iter::successors`) - rust-lang#135121 (Mark `slice::reverse` unstably const) r? `@ghost` `@rustbot` modify labels: rollup
rust-timer
added a commit
to rust-lang-ci/rust
that referenced
this pull request
Jan 6, 2025
Rollup merge of rust-lang#135118 - ranger-ross:better-docs-on-iter-fns, r=jhpratt Clarified the documentation on `core::iter::from_fn` and `core::iter::successors` This PR clarifies the closure requirements for `core::iter::from_fn` and `core::iter::successors`. `std::iter::successors` in particular is a bit difficult to understand if you are not already familiar with the signature of [`checked_mul`](https://docs.rs/num/latest/num/trait.CheckedMul.html) used in the example. See rust-lang#135087
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.
This PR clarifies the closure requirements for
core::iter::from_fnandcore::iter::successors.std::iter::successorsin particular is a bit difficult to understand if you are not already familiar with the signature ofchecked_mulused in the example.See #135087