[GODRIVER-2698] Make "Comment" field type "any" on all options structs and setters Created: 16/Dec/22  Updated: 23/Jan/24  Resolved: 11/Dec/23

Status: Closed
Project: Go Driver
Component/s: None
Affects Version/s: None
Fix Version/s: 2.0.0

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

Issue Links:
Depends
is depended on by GODRIVER-2386 Add Document Support for Comments Closed
Documented
Duplicate
is duplicated by GODRIVER-2386 Add Document Support for Comments Closed
Epic Link: Go Driver 2.0: Driver
Backwards Compatibility: Major Change
Documentation Changes: Needed
Documentation Changes Summary:

1. What would you like to communicate to the user about this feature?
Update reference to SetComment to be valid for a string or document. I.e. this:

  • - ``SetComment()``
  • An arbitrary string to help trace the operation through the database profiler, currentOp and logs.
    Default: ``""``

should be this:

{qoute}
  • - ``SetComment()``
  • An arbitrary string or document to help trace the operation through the database profiler, currentOp and logs.
    Default: ``""``

    2. Would you like the user to see examples of the syntax and/or executable code and its output?

Only if they currently exist in documentation.

3. Which versions of the driver/connector does this apply to?
v2


 Description   

The Comment field on most options structs is an interface. However, on a few structs, Comment is a string because that type was required in an earlier form of the specification. Update all Comment fields and corresponding SetComment setters to be type any.

Definition of done:

  • The Comment field on all options structs is type any.
  • The argument to SetComment on all options structs is type any.


 Comments   
Comment by Githook User [ 11/Dec/23 ]

Author:

{'name': 'Preston Vasquez', 'email': 'prestonvasquez@icloud.com', 'username': 'prestonvasquez'}

Message: GODRIVER-2698 Make Comment fields any-type on all options structs and setters (#1454)
Branch: master
https://github.com/mongodb/mongo-go-driver/commit/a372c8c037671cb6e52ce4afb95db71f61c181f3

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