core::iter::Unfold: reword docs and add example #19512
Merged
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
| /// An iterator that yields sequential Fibonacci numbers, and stops on overflow. | ||
| /// | ||
| /// ```rust | ||
| /// // Both imports available in the `core` crate as well |
There was a problem hiding this comment.
We don't need to say this, as a ton of stuff is just reexported from core. The current approach is to just treat all inline docs as though they're just in std.
|
I think the complexity is fine. r=me after removing the comment about core |
|
@steveklabnik Done! |
|
Sorry, can you squash these two real quick? |
Remove note about core
|
Squashed. |
|
❤️ |
|
Looks like this is getting rolled up in #19508. |
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.
Added the example from this Reddit thread, reworked to be more robust with correct logic (first link skipped the 0th and 1st Fibonacci numbers, second forgot about the last two valid values before overflow). Will yield all Fibonacci numbers sequentially in the range
[0, <u32 as Int>::max_value()).If the example is too complicated I can change it to a more naive version, perhaps using signed integers to check for overflow instead of
Optionand.checked_add().Also reworded the doc comments to clarify the usage and behavior of
Unfold, as the thread suggested that it wasn't really clear howUnfoldworked and when one should use it.This change is in the
corecrate but I based the example onstdsince that's where most readers will find the example. I included a note aboutcorefor clarity. Edit: removed.Tested with
rustdoc src/libcore/lib.rs. Rebased against latest master as of the creation of this PR.