update documentation for the Error function in assert or require pack…

…age stretchr#1609
architagr · Nov 2, 2024 · 2eca2b1 · 2eca2b1
1 parent 07bac60
commit 2eca2b1
Showing 1 changed file with 2 additions and 4 deletions.
diff --git a/assert/assertions.go b/assert/assertions.go
@@ -1591,10 +1591,8 @@ func NoError(t TestingT, err error, msgAndArgs ...interface{}) bool {
 
 // Error asserts that a function returned an error (i.e. not `nil`).
 //
-//	  actualObj, err := SomeFunction()
-//	  if assert.Error(t, err) {
-//		   assert.Equal(t, expectedError, err)
-//	  }
+//	actualObj, err := SomeFunction()
+//	assert.Error(t, err)
 func Error(t TestingT, err error, msgAndArgs ...interface{}) bool {
 	if err == nil {
 		if h, ok := t.(tHelper); ok {