core: fix the docs of PanicInfo::location - #162062
Open
valentynkit wants to merge 3 commits into
Open
valentynkit wants to merge 3 commits into
valentynkit wants to merge 3 commits into
Conversation
After `core::panic::PanicInfo` and `std::panic::PanicHookInfo` were split, the docs for `location` still showed incorrect usage of `std::panic::set_hook` for `core::panic::PanicInfo` location, leftover from before the split. Also notes for location methods of `PanicInfo` and `PanicHookInfo` were updated, explaining that if it is ever changed to return None, it should be addressed where the location is created and where it's unwrapped, to avoid unexpected behaviour when callers may expect to always receive location. For `PanicInfo`, `panic_fmt` builds it, and `panic_handler` unwraps it. For `PanicHookInfo`, `panic_with_hook` builds it, and `default_hook` unwraps it.
rustbot
added
S-waiting-on-review
| /// ); | ||
| /// } else { | ||
| /// println!("panic occurred but can't get location information..."); | ||
| /// write!(DEBUG_OUTPUT, "panicked at {}", location); |
Member
There was a problem hiding this comment.
I think a well-behaved panic handler would have an else branch here, so we shouldn't lose that. It should be uncommon to want no output printed for a future version of Rust that returned None.
Contributor
Author
There was a problem hiding this comment.
Thanks, added else branch, but using slightly different message than the original for this example in else branch, let me know if you would prefer to have the original line:
panic occurred but can't get location information...
Member
There was a problem hiding this comment.
Can you update https://doc.rust-lang.org/nightly/std/panic/struct.PanicHookInfo.html#method.location to match/align the fallback string?
r=me with that done
Mark-Simulacrum
added
S-waiting-on-author
Contributor
Author
|
@rustbot ready |
rustbot
added
S-waiting-on-review
Mark-Simulacrum
added
S-waiting-on-author
Use the same fallback string as the PanicInfo::location example in the PanicHookInfo::location and Location doc examples for consistency.
Contributor
Author
|
@rustbot ready also aligned the same string in the |
rustbot
added
S-waiting-on-review
This branch has not been deployed
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
3 participants
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
After
core::panic::PanicInfoandstd::panic::PanicHookInfowere split, the docs forlocationstill showed incorrect usage ofstd::panic::set_hookforcore::panic::PanicInfolocation, leftover from before the split.Also notes for location methods of
PanicInfoandPanicHookInfowere updated, explaining that if it is ever changed to return None, it should be addressed where the location is created and where it's unwrapped, to avoid unexpected behavior when callers may expect to always receive location.PanicInfo,panic_fmtbuilds it, andpanic_handlerunwraps it.PanicHookInfo,panic_with_hookbuilds it, anddefault_hookunwraps it.Addresses: #128788
@rustbot label +A-docs
r? libs