summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorEmilio Cobos Álvarez <emilio@crisal.io>2019-01-16 23:13:06 +0100
committerEmilio Cobos Álvarez <emilio@crisal.io>2019-01-16 23:13:19 +0100
commitab538ee8d9d456bad7b828ac6402d87249c63173 (patch)
treef6a0953ec29f1897e601e18cb8f9e9cbde2a896a
parent0d004a726d932cec27d94499e48bc7e3943cb457 (diff)
Document some macros.
-rw-r--r--src/extra_assertions.rs4
1 files changed, 4 insertions, 0 deletions
diff --git a/src/extra_assertions.rs b/src/extra_assertions.rs
index b89c718a..0888bf39 100644
--- a/src/extra_assertions.rs
+++ b/src/extra_assertions.rs
@@ -1,6 +1,8 @@
//! Macros for defining extra assertions that should only be checked in testing
//! and/or CI when the `testing_only_extra_assertions` feature is enabled.
+/// Simple macro that forwards to assert! when using
+/// testing_only_extra_assertions.
#[macro_export]
macro_rules! extra_assert {
( $cond:expr ) => {
@@ -15,6 +17,8 @@ macro_rules! extra_assert {
};
}
+/// Simple macro that forwards to assert_eq! when using
+/// testing_only_extra_assertions.
#[macro_export]
macro_rules! extra_assert_eq {
( $lhs:expr , $rhs:expr ) => {