[GODRIVER-2075] Update "mtest.T.Get*Event()" documentation and function behavior to match Created: 08/Jul/21  Updated: 06/Dec/23  Resolved: 03/Oct/23

Status: Closed
Project: Go Driver
Component/s: None
Affects Version/s: None
Fix Version/s: 1.13.0, 1.13.1

Type: Improvement Priority: Unknown
Reporter: Matt Dale Assignee: Steve Silvester
Resolution: Fixed Votes: 0
Labels: None
Remaining Estimate: Not Specified
Time Spent: Not Specified
Original Estimate: Not Specified

Documentation Changes: Not Needed
Documentation Changes Summary:

1. What would you like to communicate to the user about this feature?
2. Would you like the user to see examples of the syntax and/or executable code and its output?
3. Which versions of the driver/connector does this apply to?


 Description   

Currently the GetStartedEvent(), GetSucceededEvent(), and GetFailedEvent() helpers on the mtest.T type document that they return the "most recent" event of each type, but actually return the first event of each type. Update the documentation and/or function behavior so that they match.

See code: https://github.com/mongodb/mongo-go-driver/blob/69f95615de85a03ee8bfe6b661686010215b106c/mongo/integration/mtest/mongotest.go#L263-L294

Questions:

  • Is the intent to return the most recent event or the first event?


 Comments   
Comment by Githook User [ 03/Oct/23 ]

Author:

{'name': 'Ramit Mittal', 'email': 'commitemailoframit@protonmail.com', 'username': 'ramitmittal'}

Message: GODRIVER-2075 Update "mtest.T.Get*Event()" documentation (#1407)
Branch: master
https://github.com/mongodb/mongo-go-driver/commit/d6ed7caa8ada9ddb3137ad6c0001ea3a0eee524b

Comment by Ramit Mittal [ 30/Sep/23 ]

https://github.com/mongodb/mongo-go-driver/pull/1407

Generated at Thu Feb 08 08:37:46 UTC 2024 using Jira 9.7.1#970001-sha1:2222b88b221c4928ef0de3161136cc90c8356a66.