[GODRIVER-1023] Improve GoDoc Created: 07/May/19  Updated: 15/Jan/20  Resolved: 15/Jan/20

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

Type: Epic Priority: Major - P3
Reporter: Esha Bhargava Assignee: Divjot Arora (Inactive)
Resolution: Done Votes: 0
Labels: driver-planning-backlog
Remaining Estimate: Not Specified
Time Spent: Not Specified
Original Estimate: Not Specified

Start date:
End date:
Calendar Time: 12 weeks
Scope Cost Estimate: 1
Detailed Project Statuses:

2019-12-18 : Updated target of 2020-01-20

  • We added a few more tickets to this epic and the progress depends on another ticket which will change the BSON API. Considering holidays and vacation time, adding 4 weeks.

2019-11-14 : Adding

  • Lots of incoming tickets which are higher priority. Also, getting lots of comments on the documentation PRs. Divjot is only spending 50% of this time on the project.

2019-11-01 : Original estimate 4weeks


 Description   

Many of our APIs are not documented (or minimally documented) and require users to gain a deeper understanding of the entire driver implementation before they can use (or sometimes gain awareness of) a feature. 

Our top level concepts such as clients, sessions, connections, codecs, registries should be well documented at a minimum at the function level and for most of these at the concept level.

 


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