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.

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

Type-annotate and simplify documentation of Option::unwrap_or_default #102259

Merged
merged 1 commit into from
Sep 25, 2022
Merged

Type-annotate and simplify documentation of Option::unwrap_or_default #102259

merged 1 commit into from
Sep 25, 2022

Conversation

gimbling-away
Copy link
Contributor

@gimbling-away gimbling-away commented Sep 25, 2022

Part of #100054

@rustbot rustbot added the T-libs Relevant to the library team, which will review and decide on the PR/issue. label Sep 25, 2022
@rustbot
Copy link
Collaborator

rustbot commented Sep 25, 2022

Hey! It looks like you've submitted a new PR for the library teams!

If this PR contains changes to any rust-lang/rust public library APIs then please comment with @rustbot label +T-libs-api -T-libs to tag it appropriately. If this PR contains changes to any unstable APIs please edit the PR description to add a link to the relevant API Change Proposal or create one if you haven't already. If you're unsure where your change falls no worries, just leave it as is and the reviewer will take a look and make a decision to forward on if necessary.

Examples of T-libs-api changes:

  • Stabilizing library features
  • Introducing insta-stable changes such as new implementations of existing stable traits on existing stable types
  • Introducing new or changing existing unstable library APIs (excluding permanently unstable features / features without a tracking issue)
  • Changing public documentation in ways that create new stability guarantees
  • Changing observable runtime behavior of library APIs

@rust-highfive
Copy link
Collaborator

r? @joshtriplett

(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 Sep 25, 2022
@joshtriplett
Copy link
Member

joshtriplett commented Sep 25, 2022

This is certainly an improvement, and I'm going to go ahead and merge it as such:

@bors r+ rollup

However, this also doesn't seem like a very good documentation example, given that Result::unwrap_or_default exists and would be a better choice in this case. (Your change is an improvement to the example, and the nature of the example isn't something your commit changes; this just called attention to it.)

Perhaps a better example would use an array and slice::get, or something like Iterator::min?

@bors
Copy link
Contributor

bors commented Sep 25, 2022

📌 Commit 4411d5f has been approved by joshtriplett

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 Sep 25, 2022
@GuillaumeGomez
Copy link
Member

GuillaumeGomez commented Sep 25, 2022

Wouldn't it be better instead to not need type annotation? For example:

let x: Option<u32> = None;
let y: Option<u32> = Some(12);

assert_eq!(x.unwrap_or_default(), 0);
assert_eq!(12.unwrap_or_default(), 12);

I find the usage of Result unneeded and it adds complexity for no benefit.

EDIT: After a refresh I saw @joshtriplett's comment and I guess we both agree. 😆

bors added a commit to rust-lang-ci/rust that referenced this pull request Sep 25, 2022
…fee1-dead

Rollup of 8 pull requests

Successful merges:

 - rust-lang#98111 (Clarify `[T]::select_nth_unstable*` return values)
 - rust-lang#101431 (Look at move place's type when suggesting mutable reborrow)
 - rust-lang#101800 (Constify slice.split_at_mut(_unchecked))
 - rust-lang#101997 (Remove support for legacy PM)
 - rust-lang#102194 (Note the type when unable to drop values in compile time)
 - rust-lang#102200 (Constify Default impl's for Arrays and Tuples.)
 - rust-lang#102245 (Constify cmp_min_max_by.)
 - rust-lang#102259 (Type-annotate and simplify documentation of Option::unwrap_or_default)

Failed merges:

r? `@ghost`
`@rustbot` modify labels: rollup
@gimbling-away
Copy link
Contributor Author

We can always add a better example later on =)

@GuillaumeGomez
Copy link
Member

Well, we could have done it correctly directly but it doesn't matter much. I'll just send a PR once this one is merged.

@gimbling-away
Copy link
Contributor Author

I mean, I can probably extend this PR, right now :y

@GuillaumeGomez
Copy link
Member

It's about to get merged so better not. :)

@bors bors merged commit c50303c into rust-lang:master Sep 25, 2022
@rustbot rustbot added this to the 1.66.0 milestone Sep 25, 2022
@gimbling-away gimbling-away deleted the patch-1 branch September 25, 2022 17:29
@GuillaumeGomez
Copy link
Member

@gimbles Do you want to send a PR with the code I suggested instead?

@GuillaumeGomez
Copy link
Member

I opened #102283 as a follow-up.

notriddle added a commit to notriddle/rust that referenced this pull request Sep 26, 2022
…-unwrap-or-default, r=thomcc

Improve code example for Option::unwrap_or_default

Fixes rust-lang#100054.
Follow-up of rust-lang#102259.

r? `@thomcc`
notriddle added a commit to notriddle/rust that referenced this pull request Sep 26, 2022
…-unwrap-or-default, r=thomcc

Improve code example for Option::unwrap_or_default

Fixes rust-lang#100054.
Follow-up of rust-lang#102259.

r? ``@thomcc``
bors added a commit to rust-lang-ci/rust that referenced this pull request Sep 26, 2022
…nwrap-or-default, r=thomcc

Improve code example for Option::unwrap_or_default

Fixes rust-lang#100054.
Follow-up of rust-lang#102259.

r? `@thomcc`
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
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
Development

Successfully merging this pull request may close these issues.

6 participants