Skip to content

Commit

Permalink
Rollup merge of #90798 - edmorley:doc-unreachable-custom-message, r=d…
Browse files Browse the repository at this point in the history
…tolnay

Document `unreachable!` custom panic message

The `unreachable!` docs previously did not mention that there was a second form, `unreachable!("message")` that could be used to specify a custom panic message,

The docs now mention this feature in the same wording as currently used for `unimplemented!`:
https://doc.rust-lang.org/core/macro.unimplemented.html#panics
  • Loading branch information
matthiaskrgr authored Nov 12, 2021
2 parents f522f26 + b41b2e5 commit 5b3cb68
Showing 1 changed file with 5 additions and 2 deletions.
7 changes: 5 additions & 2 deletions library/core/src/macros/mod.rs
Original file line number Diff line number Diff line change
Expand Up @@ -554,7 +554,10 @@ macro_rules! writeln {
///
/// # Panics
///
/// This will always [`panic!`].
/// This will always [`panic!`] because `unreachable!` is just a shorthand for `panic!` with a
/// fixed, specific message.
///
/// Like `panic!`, this macro has a second form for displaying custom values.
///
/// # Examples
///
Expand All @@ -581,7 +584,7 @@ macro_rules! writeln {
/// if 3*i < i { panic!("u32 overflow"); }
/// if x < 3*i { return i-1; }
/// }
/// unreachable!();
/// unreachable!("The loop should always return");
/// }
/// ```
#[macro_export]
Expand Down

0 comments on commit 5b3cb68

Please sign in to comment.