1
Fork 0

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

This commit is contained in:
Unreachable 2019-04-05 03:05:33 +00:00
parent 53f2165c54
commit 84096e0530

View file

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