Add links from assert_eq! docs to debug_assert_eq!, etc. · model-checking/verify-rust-std@5b78bae (original) (raw)

`@@ -14,6 +14,12 @@ macro_rules! panic {

`

14

14

``

15

15

`` /// Asserts that two expressions are equal to each other (using [PartialEq]).

``

16

16

`///

`

``

17

`+

/// Assertions are always checked in both debug and release builds, and cannot

`

``

18

`` +

/// be disabled. See [debug_assert_eq!] for assertions that are disabled in

``

``

19

`+

/// release builds by default.

`

``

20

`+

///

`

``

21

`` +

/// [debug_assert_eq!]: crate::debug_assert_eq

``

``

22

`+

///

`

17

23

`/// On panic, this macro will print the values of the expressions with their

`

18

24

`/// debug representations.

`

19

25

`///

`

`@@ -64,6 +70,12 @@ macro_rules! assert_eq {

`

64

70

``

65

71

`` /// Asserts that two expressions are not equal to each other (using [PartialEq]).

``

66

72

`///

`

``

73

`+

/// Assertions are always checked in both debug and release builds, and cannot

`

``

74

`` +

/// be disabled. See [debug_assert_ne!] for assertions that are disabled in

``

``

75

`+

/// release builds by default.

`

``

76

`+

///

`

``

77

`` +

/// [debug_assert_ne!]: crate::debug_assert_ne

``

``

78

`+

///

`

67

79

`/// On panic, this macro will print the values of the expressions with their

`

68

80

`/// debug representations.

`

69

81

`///

`

`@@ -122,6 +134,12 @@ macro_rules! assert_ne {

`

122

134

`/// optional if guard can be used to add additional checks that must be true for the matched value,

`

123

135

`/// otherwise this macro will panic.

`

124

136

`///

`

``

137

`+

/// Assertions are always checked in both debug and release builds, and cannot

`

``

138

`` +

/// be disabled. See [debug_assert_matches!] for assertions that are disabled in

``

``

139

`+

/// release builds by default.

`

``

140

`+

///

`

``

141

`` +

/// [debug_assert_matches!]: crate::assert_matches::debug_assert_matches

``

``

142

`+

///

`

125

143

`/// On panic, this macro will print the value of the expression with its debug representation.

`

126

144

`///

`

127

145

`` /// Like [assert!], this macro has a second form, where a custom panic message can be provided.

``