Mirrors/rust
1
0
Fork 0
mirror of https://github.com/rust-lang/rust.git synced 2026-05-17 05:25:37 +03:00
Code Issues Packages Projects Releases Wiki Activity

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

Browse Source 
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
parent 2975a3c4be 62a7bfd1ba
commit d9422f00a0
1 changed files with 3 additions and 4 deletions
Download Patch File Download Diff File Expand all files Collapse all files
src/libcore/hint.rs
+3 -4
View File
@@ -21,11 +21,10 @@
/// 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
///