Skip to content

Update Option Documentation#78037

Closed
gsquire wants to merge 1 commit into
rust-lang:masterfrom
gsquire:option-documentation-fix
Closed

Update Option Documentation#78037
gsquire wants to merge 1 commit into
rust-lang:masterfrom
gsquire:option-documentation-fix

Conversation

@gsquire

@gsquire gsquire commented Oct 17, 2020

Copy link
Copy Markdown
Contributor

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:

image

This patch updates the Option documentation for the filter function so
that the Some variant link is correctly rendered.
@rust-highfive

Copy link
Copy Markdown
Contributor

r? @cramertj

(rust_highfive has picked a reviewer for you, use r? to override)

@rust-highfive rust-highfive added the S-waiting-on-review Status: Awaiting review from the assignee but also interested parties. label Oct 17, 2020
/// 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

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

You've orphaned the mention of t here.

@pickfire pickfire Oct 17, 2020

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

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"?

@ollie27

ollie27 commented Oct 17, 2020

Copy link
Copy Markdown
Contributor

The broken link was already fixed by #77971 so it works in the nightly docs.

@gsquire

gsquire commented Oct 17, 2020

Copy link
Copy Markdown
Contributor Author

Ah okay, cool. I'll close this out then!

@gsquire gsquire closed this Oct 17, 2020
@gsquire gsquire deleted the option-documentation-fix branch October 17, 2020 15:28
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

S-waiting-on-review Status: Awaiting review from the assignee but also interested parties.

Projects

None yet

Development

Successfully merging this pull request may close these issues.

6 participants