Uploaded image for project: 'Go Driver'
  1. Go Driver
  2. GODRIVER-1023

Improve GoDoc

    XMLWordPrintableJSON

Details

    • Epic
    • Status: Closed
    • Major - P3
    • Resolution: Done
    • None
    • None
    • None
    • 1
    • Hide

      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

      Show
      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.

       

      Attachments

        Activity

          People

            divjot.arora@mongodb.com Divjot Arora (Inactive)
            esha.bhargava@mongodb.com Esha Bhargava
            Votes:
            0 Vote for this issue
            Watchers:
            0 Start watching this issue

            Dates

              Created:
              Updated:
              Resolved:
              12 weeks