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

Make the "description" package internal

XMLWordPrintableJSON

    • Type: Icon: Improvement Improvement
    • Resolution: Fixed
    • Priority: Icon: Unknown Unknown
    • 2.0.0
    • Affects Version/s: None
    • Component/s: None
    • None
    • Major Change
    • Needed
    • Hide

      1. What would you like to communicate to the user about this feature?

      The description package that was part of the stable API in v1 is no longer supported in v2. Rather, this package has been mostly internalized with the exception of the two new structs in the event: ServerDescription (replacing description.Server) and TopologyDescription (replacing description.Topology).

      2. Would you like the user to see examples of the syntax and/or executable code and its output?

      Any reference to the description package in the documentation needs to be removed.

      3. Which versions of the driver/connector does this apply to?

      v2

      Show
      1. What would you like to communicate to the user about this feature? The description package that was part of the stable API in v1 is no longer supported in v2. Rather, this package has been mostly internalized with the exception of the two new structs in the event: ServerDescription (replacing description.Server) and TopologyDescription (replacing description.Topology). 2. Would you like the user to see examples of the syntax and/or executable code and its output? Any reference to the description package in the documentation needs to be removed. 3. Which versions of the driver/connector does this apply to? v2

      Most of the "description" package does not need to be part of the public API. The few parts that do can be merged into the most appropriate package(s).

      Definition of done:

      • Move the mongo/description package into the "internal/" directory.
      • Make a copy of the description.Server and description.Topology types and move them to the event package.
        • Use the "internal" version of the server and topology descriptions in all of the driver code. Only use the "event" version for emitting events.

            Assignee:
            preston.vasquez@mongodb.com Preston Vasquez
            Reporter:
            matt.dale@mongodb.com Matt Dale
            Votes:
            0 Vote for this issue
            Watchers:
            2 Start watching this issue

              Created:
              Updated:
              Resolved: