GODRIVER-2075 Update "mtest.T.Get*Event()" documentation #1407
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
ramitmittal
had a problem deploying
to
api-report
GitHub Actions
Error
ramitmittal
had a problem deploying
to
api-report
GitHub Actions
Failure
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
GODRIVER-2075
Summary
Updated documentation for
GetStartedEvent(),GetSucceededEvent(), andGetFailedEvent()helpers on themtest.T.Background & Motivation
The documentation for these helpers states that they return the "most recent" event, however the implementation actually returns the least recent event.
Existing tests depend on this behavior (see
mongo/integration/database_test.go), therefore it is easier to change the documentation to reflect the same.