[GODRIVER-1401] ClientOptions docs Created: 04/Nov/19  Updated: 28/Oct/23  Resolved: 20/Nov/19

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

Type: Task Priority: Major - P3
Reporter: Divjot Arora (Inactive) Assignee: Divjot Arora (Inactive)
Resolution: Fixed Votes: 0
Labels: None
Remaining Estimate: Not Specified
Time Spent: Not Specified
Original Estimate: Not Specified

Epic Link: Improve GoDoc

 Description   

The ClientOptions type is unique as it is one of our largest and most complicated options types. We should make sure each option is well-documented and easily discoverable. For ApplyURI, we should document SRV polling for mongos discovery and IPv6 support.

In scope of this ticket, we should also add a top level doc.go file to the mongo/options package that should explain that all options types are builder-style and that we recommend using the builders over manually setting fields in structs as the New* functions may set defaults. We should also document that functions that take variadic options slices will merge them in a last-one wins fashion using the corresponding Merge*Options function.



 Comments   
Comment by Githook User [ 20/Nov/19 ]

Author:

{'email': 'divjot.arora@10gen.com', 'name': 'Divjot Arora', 'username': 'divjotarora'}

Message: GODRIVER-1401 ClientOptions documentation (#224)
Branch: master
https://github.com/mongodb/mongo-go-driver/commit/058ad2b281f6d5975628fb449436824336710800

Comment by Divjot Arora (Inactive) [ 15/Nov/19 ]

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

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