Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

Improve Option::inspect docs #120815

Merged
merged 1 commit into from
Feb 9, 2024
Merged

Improve Option::inspect docs #120815

merged 1 commit into from
Feb 9, 2024

Conversation

camsteffen
Copy link
Contributor

@camsteffen camsteffen commented Feb 8, 2024 •
edited

  • 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
Copy link
Collaborator

rustbot commented Feb 8, 2024

r? @m-ou-se

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

@rustbot 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
m-ou-se reviewed Feb 9, 2024
View reviewed changes
library/core/src/option.rs Outdated
Comment on lines 1077 to 1078
/// Calls `f` with a reference to the contained value if [`Some`] and
/// returns the original Option.
Copy link
Member

Choose a reason for hiding this comment

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

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.

Copy link
Contributor Author

Choose a reason for hiding this comment

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

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.

@m-ou-se 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
@camsteffen
Copy link
Contributor Author

@rustbot review

@rustbot 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
@m-ou-se
Copy link
Member

m-ou-se commented Feb 9, 2024

Thanks!

@bors r+ rollup

@bors
Copy link
Contributor

bors commented Feb 9, 2024

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

It is now in the queue for this repository.

@bors 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 matthiaskrgr mentioned this pull request Feb 9, 2024
Merged
bors added a commit to rust-lang-ci/rust that referenced this pull request Feb 9, 2024
@bors
Auto merge of rust-lang#120852 - matthiaskrgr:rollup-01pr8gj, r=matth…
de9f05a 
…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
bors added a commit to rust-lang-ci/rust that referenced this pull request Feb 9, 2024
@bors
Auto merge of rust-lang#120852 - matthiaskrgr:rollup-01pr8gj, r=matth…
d44e3b9 
…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
@bors bors merged commit 40f998d into rust-lang:master Feb 9, 2024
11 checks passed
@rustbot rustbot added this to the 1.78.0 milestone Feb 9, 2024
rust-timer added a commit to rust-lang-ci/rust that referenced this pull request Feb 9, 2024
@rust-timer
Unrolled build for rust-lang#120815
013a478 
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.
@camsteffen camsteffen deleted the inspect-docs branch February 12, 2024 17:17
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@m-ou-se m-ou-se m-ou-se left review comments

Assignees

@m-ou-se m-ou-se

Labels
S-waiting-on-bors Status: Waiting on bors to run and complete tests. Bors will change the label on completion. T-libs Relevant to the library team, which will review and decide on the PR/issue.
Projects
None yet
Milestone
1.78.0
Development

Successfully merging this pull request may close these issues.

None yet
4 participants
@camsteffen @rustbot @m-ou-se @bors