Rollup merge of #59717 - Reconcyl:master, r=steveklabnik

improve docs for std::hint::unreachable_unchecked()

Fixes #59549
This commit is contained in:
Mazdak Farrokhzad 2019-04-16 05:14:17 +02:00 committed by GitHub
commit d9422f00a0
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23

View File

@ -21,11 +21,10 @@ use intrinsics;
/// difficult-to-debug problems.
///
/// Use this function only when you can prove that the code will never call it.
/// Otherwise, consider using the [`unreachable!`] macro, which does not allow
/// optimizations but will panic when executed.
///
/// The [`unreachable!()`] macro is the safe counterpart of this function, which
/// will panic instead when executed.
///
/// [`unreachable!()`]: ../macro.unreachable.html
/// [`unreachable!`]: ../macro.unreachable.html
///
/// # Example
///