From fb51fc845aed0e3dd3337b064473f060a0fdcdc9 Mon Sep 17 00:00:00 2001 From: Daniel Nephin Date: Sat, 23 Apr 2022 13:56:37 -0400 Subject: [PATCH] small godoc improvement --- assert/assert.go | 8 +++++++- 1 file changed, 7 insertions(+), 1 deletion(-) diff --git a/assert/assert.go b/assert/assert.go index 0b9bcbd..dbd4f5a 100644 --- a/assert/assert.go +++ b/assert/assert.go @@ -99,7 +99,8 @@ import ( "gotest.tools/v3/internal/assert" ) -// BoolOrComparison can be a bool, or cmp.Comparison. See Assert() for usage. +// BoolOrComparison can be a bool, cmp.Comparison, or error. See Assert for +// details about how this type is used. type BoolOrComparison interface{} // TestingT is the subset of testing.T used by the assert package. @@ -131,6 +132,11 @@ type helperT interface { // A nil value is considered success, and a non-nil error is a failure. // The return value of error.Error is used as the failure message. // +// +// Extra details can be added to the failure message using msgAndArgs. msgAndArgs +// may be either a single string, or a format string and args that will be +// passed to fmt.Sprintf. +// // Assert uses t.FailNow to fail the test. Like t.FailNow, Assert must be called // from the goroutine running the test function, not from other // goroutines created during the test. Use Check from other goroutines.