try_unfold: Fix function docs wording #2972
Open
+1
−1
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
The wording of the documentation of the `try_unfold()` function was a bit misleading. The function signature clearly states that the closure that must be provided to the function must return a `TryFuture` that yields an `Option<(Item, T)>`. The wording of the related documentation indicated that the closure may return `None` or `Some(TryFuture)`, which is wrong. This patch fixes that wording. Signed-off-by: Matthias Beyer <[email protected]>
rustbot
added
A-stream
|
cargo doc workflow failure seems to be unrelated. It might be debatable whether the docs should mention the wrapping |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
2 participants
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.
The wording of the documentation of the
try_unfold()function was a bit misleading.The function signature clearly states that the closure that must be provided to the function must return a
TryFuturethat yields anOption<(Item, T)>.The wording of the related documentation indicated that the closure may return
NoneorSome(TryFuture), which is wrong.This patch fixes that wording.