Update Option Documentation #78037
Closed
Update Option Documentation #78037
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
This patch updates the Option documentation for the filter function so that the Some variant link is correctly rendered.
|
r? @cramertj (rust_highfive has picked a reviewer for you, use r? to override) |
rust-highfive
added
the
S-waiting-on-review
SNCPlay42
reviewed
Oct 17, 2020
| @@ -667,7 +667,7 @@ impl<T> Option<T> { | |||
| /// Returns [`None`] if the option is [`None`], otherwise calls `predicate` | |||
| /// with the wrapped value and returns: | |||
| /// | |||
| /// - [`Some(t)`] if `predicate` returns `true` (where `t` is the wrapped | |||
| /// - [`Some`] if `predicate` returns `true` (where `t` is the wrapped | |||
There was a problem hiding this comment.
You've orphaned the mention of t here.
There was a problem hiding this comment.
I think it would be good to remove the brack along with t at the back.
Maybe it would be good to mention the condition first rather than the result, like "if predicate returns true returns Some"?
|
The broken link was already fixed by #77971 so it works in the nightly docs. |
|
Ah okay, cool. I'll close this out then! |
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 patch updates the Option documentation for the filter function so that the Some variant link is correctly rendered.
Here is how it currently looks for the latest stable release: