Skip to content

Commit

Permalink
improve docs for std::hint::unreachable_unchecked()
Browse files Browse the repository at this point in the history
  • Loading branch information
Unreachable committed Apr 5, 2019
1 parent 53f2165 commit 84096e0
Showing 1 changed file with 2 additions and 3 deletions.
5 changes: 2 additions & 3 deletions src/libcore/hint.rs
Expand Up @@ -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
///
Expand Down

0 comments on commit 84096e0

Please sign in to comment.