[GODRIVER-2283] Remove inaccurate comment about AdvanceClusterTime and AdvanceOperationTime Created: 26/Jan/22  Updated: 22/Jun/22  Resolved: 15/Mar/22

Status: Closed
Project: Go Driver
Component/s: Documentation
Affects Version/s: None
Fix Version/s: 1.10.0-beta1

Type: Task Priority: Major - P3
Reporter: Max Hirschhorn Assignee: Benji Rewis (Inactive)
Resolution: Done Votes: 0
Labels: None
Remaining Estimate: Not Specified
Time Spent: Not Specified
Original Estimate: Not Specified


 Description   

The doc comment for the Session interface states that the AdvanceClusterTime() and AdvanceOperationTime() methods are for internal use only. This isn't true.

The AdvanceClusterTime() and AdvanceOperationTime() are part of the drivers specifications for sessions and causal consistency. They are expected to be used by applications wishing to manually plumb/persist a causal token for use across different logical sessions.



 Comments   
Comment by Benji Rewis (Inactive) [ 15/Mar/22 ]

The inaccurate comment is removed.

Comment by Githook User [ 15/Mar/22 ]

Author:

{'name': 'Benjamin Rewis', 'email': '32186188+benjirewis@users.noreply.github.com', 'username': 'benjirewis'}

Message: GODRIVER-2283 Remove innacurate comment about AdvanceCluster/OperationTime (#875)
Branch: master
https://github.com/mongodb/mongo-go-driver/commit/af547798fb56452730380b4a07acb0dc2ec2c383

Comment by Benji Rewis (Inactive) [ 15/Mar/22 ]

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

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