[GODRIVER-1329] Document public types in the mongo package Created: 02/Oct/19  Updated: 28/Oct/23  Resolved: 22/Nov/19

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

Type: Improvement Priority: Major - P3
Reporter: David Golden 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   

We should document any user facing types in the mongo package. For interface types like Session where the concrete type is not easily discoverable from the main docs, the interface docs should document how the methods are to be used. See io.Reader docs as an example of how the methods of an interface can be documented.



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

Author:

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

Message: GODRIVER-1329 Document results, errors, and BulkWrite models (#230)
Branch: master
https://github.com/mongodb/mongo-go-driver/commit/4bdff2e4151b27297b4b2890c8c580f69052fe61

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

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

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