Skip to content

Refactor examples and enhance documentation in result.rs#124959

Merged
bors merged 3 commits intorust-lang:masterfrom
renatoalvesca:update-result-documentation
May 16, 2024
Merged

Refactor examples and enhance documentation in result.rs#124959
bors merged 3 commits intorust-lang:masterfrom
renatoalvesca:update-result-documentation

Conversation

@renatoalvesca
Copy link
Contributor

@renatoalvesca renatoalvesca commented May 10, 2024

  • Replaced map with map_err in the error handling example for correctness
  • Reordered example code to improve readability and logical flow
  • Added assertions to examples to demonstrate expected outcomes

@rustbot
Copy link
Collaborator

rustbot commented May 10, 2024

Thanks for the pull request, and welcome! The Rust team is excited to review your changes, and you should hear from @joboet (or someone else) some time within the next two weeks.

Please see the contribution instructions for more information. Namely, in order to ensure the minimum review times lag, PR authors and assigned reviewers should ensure that the review label (S-waiting-on-review and S-waiting-on-author) stays updated, invoking these commands when appropriate:

  • @rustbot author: the review is finished, PR author should check the comments and take action accordingly
  • @rustbot review: the author is ready for a review, this PR will be queued again in the reviewer's queue

@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 May 10, 2024
@rust-log-analyzer

This comment has been minimized.

Sign in to view
workingjubilee
workingjubilee reviewed May 10, 2024
View reviewed changes
joboet
joboet reviewed May 15, 2024
View reviewed changes
Copy link
Member

@joboet joboet left a comment

Choose a reason for hiding this comment

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

Sure, why not! r=me1 after the typo is fixed.

Footnotes

  1. r=me is a shorthand we use to tell other reviewers that they can approve this on my behalf. You don't have to do anything about it. ↩

@renatoalvesca @joboet
Update library/core/src/result.rs
e1611aa 
Co-authored-by: joboet <jonasboettiger@icloud.com>
@joboet
Copy link
Member

joboet commented May 16, 2024

Thanks!
@bors r+ rollup

@bors
Copy link
Collaborator

bors commented May 16, 2024

📌 Commit e1611aa has been approved by joboet

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 May 16, 2024
@bors
Copy link
Collaborator

bors commented May 16, 2024

⌛ Testing commit e1611aa with merge 4a78c00...

@bors
Copy link
Collaborator

bors commented May 16, 2024

☀️ Test successful - checks-actions
Approved by: joboet
Pushing 4a78c00 to master...

@bors bors added the merged-by-bors This PR was explicitly merged by bors. label May 16, 2024
@bors bors merged commit 4a78c00 into rust-lang:master May 16, 2024
@rustbot rustbot added this to the 1.80.0 milestone May 16, 2024
@rust-timer
Copy link
Collaborator

rust-timer commented May 16, 2024

Finished benchmarking commit (4a78c00): comparison URL.

Overall result: ✅ improvements - no action needed

@rustbot label: -perf-regression

Instruction count

This is a highly reliable metric that was used to determine the overall result at the top of this comment.

mean range count
Regressions ❌
(primary)		 - - 0
Regressions ❌
(secondary)		 - - 0
Improvements ✅
(primary)		 - - 0
Improvements ✅
(secondary)		 -0.4% [-0.5%, -0.4%] 2
All ❌✅ (primary) - - 0

Max RSS (memory usage)

Results (primary -2.5%)

This is a less reliable metric that may be of interest but was not used to determine the overall result at the top of this comment.

mean range count
Regressions ❌
(primary)		 - - 0
Regressions ❌
(secondary)		 - - 0
Improvements ✅
(primary)		 -2.5% [-2.9%, -2.1%] 2
Improvements ✅
(secondary)		 - - 0
All ❌✅ (primary) -2.5% [-2.9%, -2.1%] 2

Cycles

This benchmark run did not return any relevant results for this metric.

Binary size

This benchmark run did not return any relevant results for this metric.

Bootstrap: 679.188s -> 679.603s (0.06%)
Artifact size: 316.03 MiB -> 316.12 MiB (0.03%)

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Reviewers

@joboet joboet joboet left review comments

@workingjubilee workingjubilee workingjubilee left review comments

Assignees

@joboet joboet

Labels

merged-by-bors This PR was explicitly merged by bors. 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.80.0

Development

Successfully merging this pull request may close these issues.

7 participants

@renatoalvesca @rustbot @rust-log-analyzer @joboet @bors @rust-timer @workingjubilee