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

Create Go Doc Examples From Unstable API Examples

XMLWordPrintableJSON

    • Type: Icon: Improvement Improvement
    • Resolution: Gone away
    • Priority: Icon: Unknown Unknown
    • None
    • Affects Version/s: None
    • Component/s: Testing
    • Hide

      1. What would you like to communicate to the user about this feature?
      2. Would you like the user to see examples of the syntax and/or executable code and its output?
      3. Which versions of the driver/connector does this apply to?

      Show
      1. What would you like to communicate to the user about this feature? 2. Would you like the user to see examples of the syntax and/or executable code and its output? 3. Which versions of the driver/connector does this apply to?

      The examples in x/mongo/driver/examples should be converted into Go Doc examples for better readability and package integration. GODRIVER-1530 , for instance, decouples the cluster monitoring test into x/mongo/driver/topology/example_test.go:

      func Example_clusterMonitoring() {
	// ...
}

            Assignee:
            timothy.kim@mongodb.com Timothy Kim
            Reporter:
            preston.vasquez@mongodb.com Preston Vasquez
            Votes:
            0 Vote for this issue
            Watchers:
            2 Start watching this issue

              Created:
              Updated:
              Resolved: