squiid/rust
1
0
Fork 0
Code Issues Pull requests Projects Activity

Rollup merge of #29417 - pmarcelll:assert-doc, r=steveklabnik

Browse source 
…m message

I recently discovered that this is not mentioned in the docs, only in
the examples, and it's not evident for people coming from C++

r? @steveklabnik
This commit is contained in:
Steve Klabnik 2015-10-28 20:27:34 -04:00
commit 2f0b4ddfa9
1 changed files with 5 additions and 0 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

5
src/libcore/macros.rs
View file

@ -34,6 +34,8 @@ macro_rules! panic {
/// This will invoke the `panic!` macro if the provided expression cannot be
/// evaluated to `true` at runtime.
///
/// This macro has a second version, where a custom panic message can be provided.
///
/// # Examples
///
/// ```
@ -99,6 +101,9 @@ macro_rules! assert_eq {
/// 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
/// message can be provided.
///
/// 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