Merge pull request #1433 from snirye/master

mock: fix FunctionalOptions docs
stretchr · Mar 22, 2024 · edd74b2 · edd74b2
2 parents 404159f + da1e147
commit edd74b2
Showing 1 changed file with 4 additions and 3 deletions.
diff --git a/mock/mock.go b/mock/mock.go
@@ -820,11 +820,12 @@ func (f *FunctionalOptionsArgument) String() string {
 	return strings.Replace(fmt.Sprintf("%#v", f.value), "[]interface {}", name, 1)
 }
 
-// FunctionalOptions returns an [FunctionalOptionsArgument] object containing the functional option type
-// and the values to check of.
+// FunctionalOptions returns an [FunctionalOptionsArgument] object containing
+// the expected functional-options to check for.
 //
 // For example:
-// Assert(t, FunctionalOptions("[]foo.FunctionalOption", foo.Opt1(), foo.Opt2()))
+//
+//	Assert(t, FunctionalOptions(foo.Opt1("strValue"), foo.Opt2(613)))
 func FunctionalOptions(value ...interface{}) *FunctionalOptionsArgument {
 	return &FunctionalOptionsArgument{
 		value: value,