DOCSP-34174: codewhisperer pt 2 (#321)

* DOCSP-34174: codewhisperer pt 2

* fix highlighting

* NR PR fixes

Author: rustagir

source/includes/fundamentals/code-snippets/CRUD/bulkOps.go

@@ -1,3 +1,4 @@
+// Performs a bulk write that performs write operations
 package main
 
 import (
@@ -52,13 +53,16 @@ func main() {
 
 	fmt.Println("\nInsertOneModel:\n")
 	{
+		// Creates instructions to insert documents describing books
 		// begin bulk insert model
 		models := []mongo.WriteModel{
 			mongo.NewInsertOneModel().SetDocument(Book{Title: "Beloved", Author: "Toni Morrison", Length: 324}),
 			mongo.NewInsertOneModel().SetDocument(Book{Title: "Outline", Author: "Rachel Cusk", Length: 258}),
 		}
 		// end bulk insert model
 
+		// Runs the bulk write operation and prints the number of
+		// inserted documents
 		results, err := coll.BulkWrite(context.TODO(), models)
 		if err != nil {
 			panic(err)
@@ -87,13 +91,16 @@ func main() {
 
 	fmt.Println("\nReplaceOneModel:\n")
 	{
+		// Creates instructions to replace the first matching document
 		// begin bulk replace model
 		models := []mongo.WriteModel{
 			mongo.NewReplaceOneModel().SetFilter(bson.D{{"title", "Lucy"}}).
 				SetReplacement(Book{Title: "On Beauty", Author: "Zadie Smith", Length: 473}),
 		}
 		// end bulk replace model
 
+		// Runs the bulk write operation and prints the number of
+		// replaced documents
 		results, err := coll.BulkWrite(context.TODO(), models)
 		if err != nil {
 			panic(err)
@@ -122,13 +129,16 @@ func main() {
 
 	fmt.Println("\nUpdateOneModel:\n")
 	{
+		// Creates instructions to update the first matching document
 		// begin bulk update model
 		models := []mongo.WriteModel{
 			mongo.NewUpdateOneModel().SetFilter(bson.D{{"author", "Elena Ferrante"}}).
 				SetUpdate(bson.D{{"$inc", bson.D{{"length", -15}}}}),
 		}
 		// end bulk update model
 
+		// Runs the bulk write operation and prints the number of
+		// updated documents
 		results, err := coll.BulkWrite(context.TODO(), models)
 		if err != nil {
 			panic(err)
@@ -157,12 +167,15 @@ func main() {
 
 	fmt.Println("\nDeleteManyModel:\n")
 	{
+		// Creates instructions to delete all documents that match the filter
 		// begin bulk delete model
 		models := []mongo.WriteModel{
 			mongo.NewDeleteManyModel().SetFilter(bson.D{{"length", bson.D{{"$gt", 300}}}}),
 		}
 		// end bulk delete model
 
+		// Runs the bulk write operation and prints the number of
+		// deleted documents
 		results, err := coll.BulkWrite(context.TODO(), models)
 		if err != nil {
 			panic(err)
@@ -208,6 +221,8 @@ func main() {
 
 	fmt.Println("\nBulkOperation Example:\n")
 	{
+		// Creates instructions to make changes to documents describing
+		// books
 		// begin unordered
 		models := []mongo.WriteModel{
 			mongo.NewInsertOneModel().SetDocument(Book{Title: "Middlemarch", Author: "George Eliot", Length: 904}),
@@ -218,8 +233,12 @@ func main() {
 				SetUpdate(bson.D{{"$inc", bson.D{{"length", 10}}}}),
 			mongo.NewDeleteManyModel().SetFilter(bson.D{{"author", bson.D{{"$regex", "Jam"}}}}),
 		}
+
+		// Specifies that the bulk write is unordered
 		opts := options.BulkWrite().SetOrdered(false)
 
+		// Runs the bulk write operation and prints a summary of the
+		// data changes
 		results, err := coll.BulkWrite(context.TODO(), models, opts)
 		if err != nil {
 			panic(err)

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

@@ -1,3 +1,4 @@
+// Runs bulk write operations on a collection by using the Go driver
 package main
 
 import (
@@ -46,14 +47,19 @@ func main() {
 
 	// begin bulk
 	coll := client.Database("sample_restaurants").Collection("restaurants")
+
+	// Creates write models that specify replace and update operations
 	models := []mongo.WriteModel{
 		mongo.NewReplaceOneModel().SetFilter(bson.D{{"name", "Cafe Tomato"}}).
 			SetReplacement(Restaurant{Name: "Cafe Zucchini", Cuisine: "French"}),
 		mongo.NewUpdateOneModel().SetFilter(bson.D{{"name", "Cafe Zucchini"}}).
 			SetUpdate(bson.D{{"$set", bson.D{{"name", "Zucchini Land"}}}}),
 	}
+
+	// Specifies that the bulk write is ordered
 	opts := options.BulkWrite().SetOrdered(true)
 
+	// Runs a bulk write operation for the specified write operations
 	results, err := coll.BulkWrite(context.TODO(), models, opts)
 	// end bulk
 

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

@@ -1,3 +1,4 @@
+// Runs a database command by using the Go driver
 package main
 
 import (
@@ -36,10 +37,15 @@ func main() {
 	{
 		// begin runCommand
 		db := client.Database("sample_restaurants")
+
+		// Retrieves statistics about the specified database
 		command := bson.D{{"dbStats", 1}}
 
 		var result bson.M
+		// Runs the command and prints the database statistics
 		err := db.RunCommand(context.TODO(), command).Decode(&result)
+
+		// Prints a message if any errors occur during the command execution
 		if err != nil {
 			panic(err)
 		}

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

@@ -1,3 +1,4 @@
+// Counts documents in a collection by using the Go driver
 package main
 
 import (
@@ -34,16 +35,23 @@ func main() {
 
 	// begin countDocuments
 	coll := client.Database("sample_mflix").Collection("movies")
+
+	// Specifies a filter to match documents where the "countries" array
+	// includes a value of "China"
 	filter := bson.D{{"countries", "China"}}
 
+	// Retrieves and prints the estimated number of documents in the collection
 	estCount, estCountErr := coll.EstimatedDocumentCount(context.TODO())
 	if estCountErr != nil {
 		panic(estCountErr)
-	}	
+	}
+
+	// Retrieves and prints the number of documents in the collection
+	// that match the filter
 	count, err := coll.CountDocuments(context.TODO(), filter)
 	if err != nil {
 		panic(err)
-	}	
+	}
 	// end countDocuments
 
 	// When you run this file, it should print:

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

@@ -1,3 +1,4 @@
+// Deletes multiple documents from a collection by using the Go driver
 package main
 
 import (
@@ -36,13 +37,16 @@ func main() {
 	coll := client.Database("sample_mflix").Collection("movies")
 	filter := bson.D{{"runtime", bson.D{{"$gt", 800}}}}
 
+	// Deletes all documents that have a "runtime" value greater than 800
 	results, err := coll.DeleteMany(context.TODO(), filter)
 	if err != nil {
 		panic(err)
-	}	
+	}
 	// end deleteMany
 
+	// Prints the number of deleted documents
+	fmt.Printf("Documents deleted: %d\n", results.DeletedCount)
+
 	// When you run this file for the first time, it should print:
 	// Documents deleted: 4
-	fmt.Printf("Documents deleted: %d\n", results.DeletedCount)
 }

source/usage-examples/bulkWrite.txt

@@ -4,8 +4,6 @@
 Perform Bulk Operations
 =======================
 
-.. default-domain:: mongodb
-
 You can perform bulk write operations on a collection by using the
 ``BulkWrite()`` method.
 
@@ -37,7 +35,6 @@ collection:
 .. literalinclude:: /includes/usage-examples/code-snippets/bulk.go
    :start-after: begin bulk
    :end-before: end bulk
-   :emphasize-lines: 10
    :language: go
    :dedent:
 

source/usage-examples/command.txt

@@ -20,7 +20,7 @@ The following example retrieves statistics about the
 .. literalinclude:: /includes/usage-examples/code-snippets/command.go
    :start-after: begin runCommand
    :end-before: end runCommand
-   :emphasize-lines: 5
+   :emphasize-lines: 8
    :language: go
    :dedent:
 

source/usage-examples/count.txt

@@ -25,7 +25,7 @@ collection:
 .. literalinclude:: /includes/usage-examples/code-snippets/count.go
    :start-after: begin countDocuments
    :end-before: end countDocuments
-   :emphasize-lines: 4, 8
+   :emphasize-lines: 8, 15
    :language: go
    :dedent:
 

source/usage-examples/deleteMany.txt

@@ -21,7 +21,7 @@ documents matched:
 .. literalinclude:: /includes/usage-examples/code-snippets/deleteMany.go
    :start-after: begin deleteMany
    :end-before: end deleteMany
-   :emphasize-lines: 4
+   :emphasize-lines: 5
    :language: go
    :dedent: