Improve `Option::inspect` docs#120815

camsteffen · 2024-02-08T22:52:57Z

Refer to the function as "a function" instead of "the provided closure" since it is not necessarily a closure.
State that the original Option/Result is returned.
Adjust the example for Option::inspect to use chaining.

rustbot · 2024-02-08T22:53:05Z

rustbot has assigned @m-ou-se.
They will have a look at your PR within the next two weeks and either review your PR or
reassign to another reviewer.

Use r? to explicitly pick a reviewer

m-ou-se · 2024-02-09T15:03:16Z

library/core/src/option.rs

+    /// Calls `f` with a reference to the contained value if [`Some`] and
+    /// returns the original Option.


This first sentence appears on its own in some contexts (at least in search results), without the signature with the argument name "f". So, it might be better not to refer to f here by name.

Ah I was looking at the docs for Option::and_then which uses f, but I see most other methods use "a function". Changed to that.

Also I broke the "returns" statement into a separate paragraph.

camsteffen · 2024-02-09T15:55:37Z

@rustbot review

m-ou-se · 2024-02-09T16:45:27Z

Thanks!

@bors r+ rollup

bors · 2024-02-09T16:45:30Z

📌 Commit e9059cb has been approved by m-ou-se

It is now in the queue for this repository.

…iaskrgr Rollup of 11 pull requests Successful merges: - rust-lang#120351 (Implement SystemTime for UEFI) - rust-lang#120354 (improve normalization of `Pointee::Metadata`) - rust-lang#120776 (Move path implementations into `sys`) - rust-lang#120790 (better error message on download CI LLVM failure) - rust-lang#120806 (Clippy subtree update) - rust-lang#120815 (Improve `Option::inspect` docs) - rust-lang#120822 (Emit more specific diagnostics when enums fail to cast with `as`) - rust-lang#120827 (Print image input file and checksum in CI only) - rust-lang#120836 (hide impls if trait bound is proven from env) - rust-lang#120844 (Build DebugInfo for async closures) - rust-lang#120851 (Remove duplicate release note) r? `@ghost` `@rustbot` modify labels: rollup

Rollup merge of rust-lang#120815 - camsteffen:inspect-docs, r=m-ou-se Improve `Option::inspect` docs * Refer to the function as "a function" instead of "the provided closure" since it is not necessarily a closure. * State that the original Option/Result is returned. * Adjust the example for `Option::inspect` to use chaining.

rustbot assigned m-ou-se Feb 8, 2024

rustbot added S-waiting-on-review Status: Awaiting review from the assignee but also interested parties. T-libs Relevant to the library team, which will review and decide on the PR/issue. labels Feb 8, 2024

m-ou-se reviewed Feb 9, 2024

View reviewed changes

m-ou-se added S-waiting-on-author Status: This is awaiting some action (such as code changes or more information) from the author. and removed S-waiting-on-review Status: Awaiting review from the assignee but also interested parties. labels Feb 9, 2024

Improve Option::inspect docs

e9059cb

camsteffen force-pushed the inspect-docs branch from 8a10015 to e9059cb Compare February 9, 2024 15:54

rustbot added S-waiting-on-review Status: Awaiting review from the assignee but also interested parties. and removed S-waiting-on-author Status: This is awaiting some action (such as code changes or more information) from the author. labels Feb 9, 2024

bors added S-waiting-on-bors Status: Waiting on bors to run and complete tests. Bors will change the label on completion. and removed S-waiting-on-review Status: Awaiting review from the assignee but also interested parties. labels Feb 9, 2024

matthiaskrgr mentioned this pull request Feb 9, 2024

Rollup of 11 pull requests #120852

Merged

bors merged commit 40f998d into rust-lang:master Feb 9, 2024

rustbot added this to the 1.78.0 milestone Feb 9, 2024

camsteffen deleted the inspect-docs branch February 12, 2024 17:17

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Uh oh!

Improve `Option::inspect` docs#120815