From ad8dcb64bf88bcfbf7bf12c09b6bc7d0e2e3accc Mon Sep 17 00:00:00 2001 From: Marcell Pardavi Date: Wed, 28 Oct 2015 00:56:27 +0100 Subject: [PATCH] Mention in the docs, that `assert!` has a second version with a custom 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 --- src/libcore/macros.rs | 5 +++++ 1 file changed, 5 insertions(+) diff --git a/src/libcore/macros.rs b/src/libcore/macros.rs index bb112327abf..5b5f59d5ddb 100644 --- a/src/libcore/macros.rs +++ b/src/libcore/macros.rs @@ -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