bjoernager/rust
bjoernager/rust
1
Fork 0
Code Activity

Doc changes for assert macros

Browse source 
See #29381
This commit is contained in:
Michael Kohl 2017-06-05 16:46:12 +07:00
parent c94a9ac8ae
commit 867ed2e17d
1 changed files with 13 additions and 5 deletions
Download patch file Download diff file Expand all files Collapse all files

18
src/libcore/macros.rs
View file

@ -35,6 +35,8 @@ macro_rules! panic {
/// 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. /// evaluated to `true` at runtime.
/// ///
/// # Uses
///
/// Assertions are always checked in both debug and release builds, and cannot /// 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. /// release builds by default.
@ -45,7 +47,9 @@ macro_rules! panic {
/// Other use-cases of `assert!` include [testing] and enforcing run-time /// Other use-cases of `assert!` include [testing] and enforcing run-time
/// invariants in safe code (whose violation cannot result in unsafety). /// invariants in safe code (whose violation cannot result in unsafety).
/// ///
/// This macro has a second version, where a custom panic message can /// # Custom Messages
///
/// This macro has a second form, where a custom panic message can
/// be provided with or without arguments for formatting. /// be provided with or without arguments for formatting.
/// ///
/// [`panic!`]: macro.panic.html /// [`panic!`]: macro.panic.html
@ -85,14 +89,15 @@ macro_rules! assert {
); );
} }
/// Asserts that two expressions are equal to each other. /// Asserts that two expressions are equal to each other (using [`PartialEq`]).
/// ///
/// On panic, this macro will print the values of the expressions with their /// On panic, this macro will print the values of the expressions with their
/// debug representations. /// debug representations.
/// ///
/// Like [`assert!`], this macro has a second version, where a custom /// Like [`assert!`], this macro has a second form, where a custom
/// panic message can be provided. /// panic message can be provided.
/// ///
/// [`PartialEq`]: cmp/trait.PartialEq.html
/// [`assert!`]: macro.assert.html /// [`assert!`]: macro.assert.html
/// ///
/// # Examples /// # Examples
@ -130,14 +135,15 @@ macro_rules! assert_eq {
}); });
} }
/// Asserts that two expressions are not equal to each other. /// Asserts that two expressions are not equal to each other (using [`PartialEq`]).
/// ///
/// On panic, this macro will print the values of the expressions with their /// On panic, this macro will print the values of the expressions with their
/// debug representations. /// debug representations.
/// ///
/// Like `assert!()`, this macro has a second version, where a custom /// Like [`assert!`], this macro has a second form, where a custom
/// panic message can be provided. /// panic message can be provided.
/// ///
/// [`PartialEq`]: cmp/trait.PartialEq.html
/// [`assert!`]: macro.assert.html /// [`assert!`]: macro.assert.html
/// ///
/// # Examples /// # Examples
@ -183,6 +189,8 @@ macro_rules! assert_ne {
/// 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. /// message can be provided.
/// ///
/// # Uses
///
/// 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 /// optimized builds by default. An optimized build will omit all
/// `debug_assert!` statements unless `-C debug-assertions` is passed to the /// `debug_assert!` statements unless `-C debug-assertions` is passed to the