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

Use Display in top-level example for PanicInfo #110110

Merged
merged 1 commit into from
Apr 14, 2023

Conversation

lukas-code
Copy link
Member

@lukas-code lukas-code commented Apr 9, 2023

Addresses #110098.

This confused me as well, when I was writing a no_std panic handler for the first time, so here's a better top-level example.

Display is stable, prints the .message() if available, and falls back to .payload().downcast_ref<&str>() if the message is not available. So this example should provide strictly more information and also work for formatted panics.

The old example still exists on the payload method.

@rustbot
Copy link
Collaborator

rustbot commented Apr 9, 2023

r? @thomcc

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

@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 Apr 9, 2023
@rustbot
Copy link
Collaborator

rustbot commented Apr 9, 2023

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

@rustbot rustbot added the A-docs Area: documentation for any part of the project, including the compiler, standard library, and tools label Apr 9, 2023
@JohnTitor
Copy link
Member

Great, thank you!
r? @JohnTitor @bors r+ rollup

@bors
Copy link
Contributor

bors commented Apr 14, 2023

📌 Commit d9f99c3 has been approved by JohnTitor

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 Apr 14, 2023
bors added a commit to rust-lang-ci/rust that referenced this pull request Apr 14, 2023
…iaskrgr

Rollup of 7 pull requests

Successful merges:

 - rust-lang#108687 (Reformulate `point_at_expr_source_of_inferred_type` to be more accurate)
 - rust-lang#109272 (Add Command environment variable inheritance docs)
 - rust-lang#109947 (Add links from `core::cmp` derives to their traits)
 - rust-lang#110110 (Use `Display` in top-level example for `PanicInfo`)
 - rust-lang#110154 (Fix typos in library)
 - rust-lang#110244 (Remove some unneeded imports / qualified paths)
 - rust-lang#110328 ([rustdoc] Add explanations for auto-disambiguation when an intra doc link is resolved to a proc-macro and a trait at the same time)

Failed merges:

r? `@ghost`
`@rustbot` modify labels: rollup
@bors bors merged commit 5107c4c into rust-lang:master Apr 14, 2023
@rustbot rustbot added this to the 1.70.0 milestone Apr 14, 2023
@lukas-code lukas-code deleted the display-panic-info branch April 14, 2023 21:55
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
A-docs Area: documentation for any part of the project, including the compiler, standard library, and tools 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.

5 participants