about summary refs log tree commit diff
path: root/src/libcore
diff options
context:
space:
mode:
authorbors <bors@rust-lang.org>2019-04-16 05:28:25 +0000
committerbors <bors@rust-lang.org>2019-04-16 05:28:25 +0000
commita7cef0bf0810d04da3101fe079a0625d2756744a (patch)
treec4bc4ef5c616d0a34c269800d459b0e218884b6d /src/libcore
parent7cb933a616b64303a022a97487c3d658ff4b17ed (diff)
parent67ff8cfde88ecc840a2b85091c5253391f5bea07 (diff)
downloadrust-a7cef0bf0810d04da3101fe079a0625d2756744a.tar.gz
rust-a7cef0bf0810d04da3101fe079a0625d2756744a.zip
Auto merge of #60007 - Centril:rollup-gdh1er4, r=Centril
Rollup of 6 pull requests

Successful merges:

 - #59717 (improve docs for std::hint::unreachable_unchecked())
 - #59903 (Continue evaluating after missing main)
 - #59973 (Fix rustdoc sidebar z-index)
 - #59992 (rustdoc: use --static-root-path for settings.js)
 - #59993 (include mode in unused binding suggestion span)
 - #60000 (Add repo-specific triagebot configuration)

Failed merges:

r? @ghost
Diffstat (limited to 'src/libcore')
-rw-r--r--src/libcore/hint.rs7
1 files changed, 3 insertions, 4 deletions
diff --git a/src/libcore/hint.rs b/src/libcore/hint.rs
index d43e6c49f4c..89bf3640968 100644
--- a/src/libcore/hint.rs
+++ b/src/libcore/hint.rs
@@ -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
 ///