bjoernager/rust
bjoernager/rust
1
Fork 0
Code Activity

Rollup merge of #61084 - blkerby:unreachable_doc, r=KodrAus

Browse source 
Clarify docs for unreachable! macro

Fixes #60754.
This commit is contained in:
Mazdak Farrokhzad 2019-05-28 11:48:53 +02:00 • committed by GitHub
commit 08f7724355
No known key found for this signature in database
GPG key ID: 4AEE18F83AFDEB23
1 changed files with 4 additions and 3 deletions
Download patch file Download diff file Expand all files Collapse all files

7
src/libcore/macros.rs
View file

@ -445,9 +445,10 @@ macro_rules! writeln {
/// * Iterators that dynamically terminate. /// * Iterators that dynamically terminate.
/// ///
/// If the determination that the code is unreachable proves incorrect, the /// If the determination that the code is unreachable proves incorrect, the
/// program immediately terminates with a [`panic!`]. The function [`unreachable_unchecked`], /// program immediately terminates with a [`panic!`].
/// which belongs to the [`std::hint`] module, informs the compiler to ///
/// optimize the code out of the release version entirely. /// The unsafe counterpart of this macro is the [`unreachable_unchecked`] function, which
/// will cause undefined behavior if the code is reached.
/// ///
/// [`panic!`]: ../std/macro.panic.html /// [`panic!`]: ../std/macro.panic.html
/// [`unreachable_unchecked`]: ../std/hint/fn.unreachable_unchecked.html /// [`unreachable_unchecked`]: ../std/hint/fn.unreachable_unchecked.html