Skip to content

Commit d6ed7ca

Browse files
authored
GODRIVER-2075 Update "mtest.T.Get*Event()" documentation (#1407)
1 parent cd3c699 commit d6ed7ca

File tree

1 file changed

+3
-9
lines changed

1 file changed

+3
-9
lines changed

mongo/integration/mtest/mongotest.go

Lines changed: 3 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -278,11 +278,9 @@ func (t *T) ClearMockResponses() {
278278
t.mockDeployment.clearResponses()
279279
}
280280

281-
// GetStartedEvent returns the most recent CommandStartedEvent, or nil if one is not present.
281+
// GetStartedEvent returns the least recent CommandStartedEvent, or nil if one is not present.
282282
// This can only be called once per event.
283283
func (t *T) GetStartedEvent() *event.CommandStartedEvent {
284-
// TODO(GODRIVER-2075): GetStartedEvent documents that it returns the most recent event, but actually returns the first
285-
// TODO event. Update either the documentation or implementation.
286284
if len(t.started) == 0 {
287285
return nil
288286
}
@@ -291,11 +289,9 @@ func (t *T) GetStartedEvent() *event.CommandStartedEvent {
291289
return e
292290
}
293291

294-
// GetSucceededEvent returns the most recent CommandSucceededEvent, or nil if one is not present.
292+
// GetSucceededEvent returns the least recent CommandSucceededEvent, or nil if one is not present.
295293
// This can only be called once per event.
296294
func (t *T) GetSucceededEvent() *event.CommandSucceededEvent {
297-
// TODO(GODRIVER-2075): GetSucceededEvent documents that it returns the most recent event, but actually returns the
298-
// TODO first event. Update either the documentation or implementation.
299295
if len(t.succeeded) == 0 {
300296
return nil
301297
}
@@ -304,11 +300,9 @@ func (t *T) GetSucceededEvent() *event.CommandSucceededEvent {
304300
return e
305301
}
306302

307-
// GetFailedEvent returns the most recent CommandFailedEvent, or nil if one is not present.
303+
// GetFailedEvent returns the least recent CommandFailedEvent, or nil if one is not present.
308304
// This can only be called once per event.
309305
func (t *T) GetFailedEvent() *event.CommandFailedEvent {
310-
// TODO(GODRIVER-2075): GetFailedEvent documents that it returns the most recent event, but actually returns the first
311-
// TODO event. Update either the documentation or implementation.
312306
if len(t.failed) == 0 {
313307
return nil
314308
}

0 commit comments

Comments
 (0)