Skip to content

Commit f8c01f3

Browse files
authored
mock: Mock.Return does not exist anymore
Remove mentions of removed function the docs and comment.
1 parent 12f8b56 commit f8c01f3

1 file changed

Lines changed: 5 additions & 6 deletions

File tree

mock/mock.go

Lines changed: 5 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -470,7 +470,7 @@ func callString(method string, arguments Arguments, includeArgumentValues bool)
470470

471471
// Called tells the mock object that a method has been called, and gets an array
472472
// of arguments to return. Panics if the call is unexpected (i.e. not preceded by
473-
// appropriate .On .Return() calls)
473+
// appropriate [Mock.On] calls)
474474
// If Call.WaitFor is set, blocks until the channel is closed or receives a message.
475475
func (m *Mock) Called(arguments ...interface{}) Arguments {
476476
// get the calling function's name
@@ -493,7 +493,7 @@ func (m *Mock) Called(arguments ...interface{}) Arguments {
493493

494494
// MethodCalled tells the mock object that the given method has been called, and gets
495495
// an array of arguments to return. Panics if the call is unexpected (i.e. not preceded
496-
// by appropriate .On .Return() calls)
496+
// by appropriate [Mock.On] calls)
497497
// If Call.WaitFor is set, blocks until the channel is closed or receives a message.
498498
func (m *Mock) MethodCalled(methodName string, arguments ...interface{}) Arguments {
499499
m.mutex.Lock()
@@ -510,8 +510,7 @@ func (m *Mock) MethodCalled(methodName string, arguments ...interface{}) Argumen
510510
// as the return arguments. This is because:
511511
//
512512
// a) this is a totally unexpected call to this method,
513-
// b) the arguments are not what was expected, or
514-
// c) the developer has forgotten to add an accompanying On...Return pair.
513+
// b) the arguments are not what was expected
515514
closestCall, mismatch := m.findClosestCall(methodName, arguments...)
516515
m.mutex.Unlock()
517516

@@ -595,7 +594,7 @@ type assertExpectationiser interface {
595594
AssertExpectations(TestingT) bool
596595
}
597596

598-
// AssertExpectationsForObjects asserts that everything specified with On and Return
597+
// AssertExpectationsForObjects asserts that everything specified with [Mock.On]
599598
// of the specified objects was in fact called as expected.
600599
//
601600
// Calls may have occurred in any order.
@@ -618,7 +617,7 @@ func AssertExpectationsForObjects(t TestingT, testObjects ...interface{}) bool {
618617
return true
619618
}
620619

621-
// AssertExpectations asserts that everything specified with On and Return was
620+
// AssertExpectations asserts that everything specified with [Mock.On] was
622621
// in fact called as expected. Calls may have occurred in any order.
623622
func (m *Mock) AssertExpectations(t TestingT) bool {
624623
if s, ok := t.(interface{ Skipped() bool }); ok && s.Skipped() {

0 commit comments

Comments
 (0)