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

Document public types in the mongo package

    XMLWordPrintable

    Details

    • Type: Improvement
    • Status: Closed
    • Priority: Major - P3
    • Resolution: Fixed
    • Affects Version/s: None
    • Fix Version/s: 1.2.0
    • Component/s: Documentation
    • Labels:
      None

      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.

        Attachments

          Activity

            People

            Assignee:
            divjot.arora Divjot Arora
            Reporter:
            david.golden David Golden
            Votes:
            0 Vote for this issue
            Watchers:
            2 Start watching this issue

              Dates

              Created:
              Updated:
              Resolved: