[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: |
| Comment by Divjot Arora (Inactive) [ 22/Nov/19 ] |