DOCSP-34174: codewhisperer pt 3 (#322)

Author: rustagir

source/includes/usage-examples/code-snippets/deleteOne.go

@@ -1,3 +1,4 @@
+// Deletes a document from a collection by using the Go driver
 package main
 
 import (
@@ -36,13 +37,18 @@ func main() {
 	coll := client.Database("sample_mflix").Collection("movies")
 	filter := bson.D{{"title", "Twilight"}}
 
+	// Deletes the first document that has a "title" value of "Twilight"
 	result, err := coll.DeleteOne(context.TODO(), filter)
+
+	// Prints a message if any errors occur during the operation
 	if err != nil {
 		panic(err)
 	}
 	// end deleteOne
 
+	// Prints the number of deleted documents
+	fmt.Printf("Documents deleted: %d\n", result.DeletedCount)
+
 	// When you run this file for the first time, it should print:
 	// Documents deleted: 1
-	fmt.Printf("Documents deleted: %d\n", result.DeletedCount)
 }

source/includes/usage-examples/code-snippets/distinct.go

@@ -1,3 +1,4 @@
+// Retrieves distinct values of a field by using the Go driver
 package main
 
 import (
@@ -36,16 +37,22 @@ func main() {
 	coll := client.Database("sample_mflix").Collection("movies")
 	filter := bson.D{{"directors", "Natalie Portman"}}
 
+	// Retrieves the distinct values of the "title" field in documents
+	// that match the filter
 	results, err := coll.Distinct(context.TODO(), "title", filter)
+
+	// Prints a message if any errors occur during the operation
 	if err != nil {
 		panic(err)
-	}	
+	}
 	// end distinct
 
-	// When you run this file, it should print:
-	// A Tale of Love and Darkness
-	// New York, I Love You
+	// Prints the distinct "title" values
 	for _, result := range results {
 		fmt.Println(result)
 	}
+
+	// When you run this file, it should print:
+	// A Tale of Love and Darkness
+	// New York, I Love You
 }

source/includes/usage-examples/code-snippets/find.go

@@ -1,3 +1,4 @@
+// Retrieves documents that match a query filter by using the Go driver
 package main
 
 import (
@@ -49,8 +50,12 @@ func main() {
 
 	// begin find
 	coll := client.Database("sample_restaurants").Collection("restaurants")
+
+	// Creates a query filter to match documents in which the "cuisine"
+	// is "Italian"
 	filter := bson.D{{"cuisine", "Italian"}}
 
+	// Retrieves documents that match the query filer
 	cursor, err := coll.Find(context.TODO(), filter)
 	if err != nil {
 		panic(err)
@@ -62,6 +67,7 @@ func main() {
 		panic(err)
 	}
 
+	// Prints the results of the find operation as structs
 	for _, result := range results {
 		cursor.Decode(&result)
 		output, err := json.MarshalIndent(result, "", "    ")

source/includes/usage-examples/code-snippets/findOne.go

@@ -1,3 +1,4 @@
+// Retrieves a document that matches a query filter by using the Go driver
 package main
 
 import (
@@ -49,14 +50,19 @@ func main() {
 
 	// begin findOne
 	coll := client.Database("sample_restaurants").Collection("restaurants")
+
+	// Creates a query filter to match documents in which the "name" is
+	// "Bagels N Buns"
 	filter := bson.D{{"name", "Bagels N Buns"}}
 
+	// Retrieves the first matching document
 	var result Restaurant
 	err = coll.FindOne(context.TODO(), filter).Decode(&result)
 
+	// Prints a message if no documents are matched or if any
+	// other errors occur during the operation
 	if err != nil {
 		if err == mongo.ErrNoDocuments {
-			// This error means your query did not match any documents.
 			return
 		}
 		panic(err)

source/includes/usage-examples/code-snippets/insertMany.go

@@ -1,3 +1,4 @@
+// Inserts sample documents describing restaurants by using the Go driver
 package main
 
 import (
@@ -45,21 +46,26 @@ func main() {
 
 	// begin insertMany
 	coll := client.Database("sample_restaurants").Collection("restaurants")
+
+	// Creates two sample documents describing restaurants
 	newRestaurants := []interface{}{
 		Restaurant{Name: "Rule of Thirds", Cuisine: "Japanese"},
 		Restaurant{Name: "Madame Vo", Cuisine: "Vietnamese"},
 	}
 
+	// Inserts sample documents into the collection
 	result, err := coll.InsertMany(context.TODO(), newRestaurants)
 	if err != nil {
 		panic(err)
 	}
 	// end insertMany
 
-	// When you run this file, it should print:
-	// 2 documents inserted with IDs: ObjectID("..."), ObjectID("...")
+	// Prints the IDs of the inserted documents
 	fmt.Printf("%d documents inserted with IDs:\n", len(result.InsertedIDs))
 	for _, id := range result.InsertedIDs {
 		fmt.Printf("\t%s\n", id)
 	}
+
+	// When you run this file, it should print:
+	// 2 documents inserted with IDs: ObjectID("..."), ObjectID("...")
 }

source/usage-examples/deleteOne.txt

@@ -4,8 +4,6 @@
 Delete a Document
 =================
 
-.. default-domain:: mongodb
-
 You can delete a document in a collection by using the ``DeleteOne()``
 method.
 
@@ -21,7 +19,7 @@ matched:
 .. literalinclude:: /includes/usage-examples/code-snippets/deleteOne.go
    :start-after: begin deleteOne
    :end-before: end deleteOne
-   :emphasize-lines: 4
+   :emphasize-lines: 5
    :language: go
    :dedent:
 
@@ -37,7 +35,7 @@ in the ``movies`` collection:
    :copyable: false
 
    // result truncated
-   { "_id": ObjectId("573a13bff29313caabd5e06b"), ..., "title": "Twilight", ... }
+   { "_id": ObjectId("..."), ..., "title": "Twilight", ... }
 
 For an example on how to find a document, see :ref:`golang-find-one`.
 

source/usage-examples/distinct.txt

@@ -4,8 +4,6 @@
 Retrieve Distinct Values of a Field
 ===================================
 
-.. default-domain:: mongodb
-
 You can retrieve a list of distinct values for a field across a
 collection by using the ``Distinct()`` method.
 
@@ -23,7 +21,7 @@ collection:
 .. literalinclude:: /includes/usage-examples/code-snippets/distinct.go
    :start-after: begin distinct
    :end-before: end distinct
-   :emphasize-lines: 4
+   :emphasize-lines: 6
    :language: go
    :dedent:
 

source/usage-examples/find.txt

@@ -32,7 +32,7 @@ in which the ``cuisine`` is "Italian", returning all documents matched:
    :end-before: end find
    :language: go
    :dedent:
-   :emphasize-lines: 4
+   :emphasize-lines: 8
 
 View a `fully runnable example <{+example+}/find.go>`__
 

source/usage-examples/findOne.txt

@@ -33,7 +33,7 @@ matched:
    :end-before: end findOne
    :language: go
    :dedent:
-   :emphasize-lines: 5
+   :emphasize-lines: 9
 
 View a `fully runnable example <{+example+}/findOne.go>`__
 

source/usage-examples/insertMany.txt

@@ -35,7 +35,7 @@ collection:
 .. literalinclude:: /includes/usage-examples/code-snippets/insertMany.go
    :start-after: begin insertMany
    :end-before: end insertMany
-   :emphasize-lines: 7
+   :emphasize-lines: 10
    :language: go
    :dedent: