[GODRIVER-530] Create Production Quality GoDocs Documentation Created: 23/Aug/18 Updated: 27/Oct/23 Resolved: 13/May/19 |
|
| Status: | Closed |
| Project: | Go Driver |
| Component/s: | None |
| Affects Version/s: | None |
| Fix Version/s: | None |
| Type: | Epic | Priority: | Major - P3 |
| Reporter: | Kristofer Brandow (Inactive) | Assignee: | Unassigned |
| Resolution: | Gone away | Votes: | 0 |
| Labels: | None | ||
| Remaining Estimate: | Not Specified | ||
| Time Spent: | Not Specified | ||
| Original Estimate: | Not Specified | ||
| Description |
|
The current Go driver documentation is currently lacking in quality. The godoc documentation is verbose and unhelpful for users attempting to learn how the driver works. This epic encompasses the work necessary for updating the docs. It is likely that more work will need to be done around options to make the documentation cleaner. |
| Comments |
| Comment by Ian Whalen (Inactive) [ 07/Dec/18 ] |
|
No target date for now because we need to figure out what's actually required by the Go team here. |