Rollup merge of #90798 - edmorley:doc-unreachable-custom-message, r=dtolnay
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
This commit is contained in:
@@ -554,7 +554,10 @@ macro_rules! writeln {
|
|||||||
///
|
///
|
||||||
/// # Panics
|
/// # 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
|
/// # Examples
|
||||||
///
|
///
|
||||||
@@ -581,7 +584,7 @@ macro_rules! writeln {
|
|||||||
/// if 3*i < i { panic!("u32 overflow"); }
|
/// if 3*i < i { panic!("u32 overflow"); }
|
||||||
/// if x < 3*i { return i-1; }
|
/// if x < 3*i { return i-1; }
|
||||||
/// }
|
/// }
|
||||||
/// unreachable!();
|
/// unreachable!("The loop should always return");
|
||||||
/// }
|
/// }
|
||||||
/// ```
|
/// ```
|
||||||
#[macro_export]
|
#[macro_export]
|
||||||
|
|||||||
Reference in New Issue
Block a user