Skip to content

Commit 505f50f

Browse files
authored
[doc] add documentation for DeepEqual and NotDeepEqual (#14)
1 parent cc919ca commit 505f50f

File tree

1 file changed

+4
-0
lines changed

1 file changed

+4
-0
lines changed

README.md

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -41,6 +41,10 @@ func Test_1Plus1ShouldEqual2(t *testing.T) {
4141
### Equality
4242
* `Equal` - asserts two values are equal. Values must be comparable
4343
* `NotEqual` - asserts two values are not equal. Values must be comparable
44+
* `DeepEqual` - asserts two values are deeply equal. Internally uses `reflect.DeepEqual`.
45+
Can be used to assert equality of arrays, slices and maps
46+
* `NotDeepEqual` - asserts two values are deeply not equal. Internally uses `reflect.DeepEqual`.
47+
Can be used to assert inequality of arrays, slices and maps
4448
* `Nil` - asserts the value is nil
4549
* `NotNil` - asserts the value is not nil
4650
* `SimilarSlice` - asserts two slices have the same values in any order. The elements must be comparable

0 commit comments

Comments
 (0)