OpenE2K
/
rust
2
0
Fork 0
Code Issues Pull Requests Projects Releases Wiki Activity

Rollup merge of #40327 - GuillaumeGomez:macros-urls, r=frewsxcv 

Add missing urls in some macros doc

r? @frewsxcv
This commit is contained in:
Ariel Ben-Yehuda 2017-03-08 20:54:07 +02:00 committed by GitHub
parent 5ad3f09216 65ac1e92fe
commit e8eb05cddd
1 changed files with 16 additions and 7 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

23
src/libcore/macros.rs
View File

@ -32,11 +32,11 @@ macro_rules! panic {
/// Ensure that a boolean expression is `true` at runtime.
///
/// This will invoke the `panic!` macro if the provided expression cannot be
/// This will invoke the [`panic!`] macro if the provided expression cannot be
/// evaluated to `true` at runtime.
///
/// Assertions are always checked in both debug and release builds, and cannot
/// be disabled. See `debug_assert!` for assertions that are not enabled in
/// be disabled. See [`debug_assert!`] for assertions that are not enabled in
/// release builds by default.
///
/// Unsafe code relies on `assert!` to enforce run-time invariants that, if
@ -48,6 +48,8 @@ macro_rules! panic {
/// This macro has a second version, where a custom panic message can
/// be provided with or without arguments for formatting.
///
/// [`panic!`]: macro.panic.html
/// [`debug_assert!`]: macro.debug_assert.html
/// [testing]: ../book/testing.html
///
/// # Examples
@ -88,9 +90,11 @@ macro_rules! assert {
/// On panic, this macro will print the values of the expressions with their
/// debug representations.
///
/// Like `assert!()`, this macro has a second version, where a custom
/// Like [`assert!()`], this macro has a second version, where a custom
/// panic message can be provided.
///
/// [`assert!()`]: macro.assert.html
///
/// # Examples
///
/// ```
@ -134,6 +138,8 @@ macro_rules! assert_eq {
/// Like `assert!()`, this macro has a second version, where a custom
/// panic message can be provided.
///
/// [`assert!`]: macro.assert.html
///
/// # Examples
///
/// ```
@ -171,13 +177,13 @@ macro_rules! assert_ne {
/// Ensure that a boolean expression is `true` at runtime.
///
/// This will invoke the `panic!` macro if the provided expression cannot be
/// This will invoke the [`panic!`] macro if the provided expression cannot be
/// evaluated to `true` at runtime.
///
/// Like `assert!`, this macro also has a second version, where a custom panic
/// Like [`assert!`], this macro also has a second version, where a custom panic
/// message can be provided.
///
/// Unlike `assert!`, `debug_assert!` statements are only enabled in non
/// Unlike [`assert!`], `debug_assert!` statements are only enabled in non
/// optimized builds by default. An optimized build will omit all
/// `debug_assert!` statements unless `-C debug-assertions` is passed to the
/// compiler. This makes `debug_assert!` useful for checks that are too
@ -187,10 +193,13 @@ macro_rules! assert_ne {
/// An unchecked assertion allows a program in an inconsistent state to keep
/// running, which might have unexpected consequences but does not introduce
/// unsafety as long as this only happens in safe code. The performance cost
/// of assertions, is however, not measurable in general. Replacing `assert!`
/// of assertions, is however, not measurable in general. Replacing [`assert!`]
/// with `debug_assert!` is thus only encouraged after thorough profiling, and
/// more importantly, only in safe code!
///
/// [`panic!`]: macro.panic.html
/// [`assert!`]: macro.assert.html
///
/// # Examples
///
/// ```