DOCSP-34174: codewhisperer pt 6 (#325)

* DOCSP-34174: codewhisperer pt 6

* CD PR fixes

Author: rustagir

source/fundamentals/aggregation.txt

@@ -4,8 +4,6 @@
 Aggregation
 ===========
 
-.. default-domain:: mongodb
-
 .. contents:: On this page
    :local:
    :backlinks: none

source/fundamentals/logging.txt

@@ -195,7 +195,7 @@ following specifications:
 .. literalinclude:: /includes/fundamentals/code-snippets/logging.go
    :language: go
    :dedent:
-   :emphasize-lines: 1-4, 9
+   :emphasize-lines: 1-4, 10
    :start-after: start-standard-logger
    :end-before: end-standard-logger
 
@@ -270,7 +270,6 @@ This example demonstrates how to define and implement a custom logger.
       .. literalinclude:: /includes/fundamentals/code-snippets/logging.go
          :language: go
          :dedent:
-         :emphasize-lines: 1-2, 4-8, 13
          :start-after: start-set-customlogger
          :end-before: end-set-customlogger
 
@@ -357,7 +356,6 @@ a third-party logging package, into your application.
       .. literalinclude:: /includes/fundamentals/code-snippets/logging.go
          :language: go
          :dedent:
-         :emphasize-lines: 1, 3-6, 11
          :start-after: start-set-thirdparty-logger
          :end-before: end-set-thirdparty-logger
 

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

@@ -1,3 +1,4 @@
+// Updates or inserts a matching document by using the Go driver
 package main
 
 import (
@@ -56,11 +57,17 @@ func main() {
 
 	fmt.Println("\nUpsert:\n")
 	{
+		// Creates a filter to match documents with a specified
+		// "species" and "plant_id" and an update document to set new fields
 		// begin upsert
 		filter := bson.D{{"species", "Ledebouria socialis"}, {"plant_id", 3}}
 		update := bson.D{{"$set", bson.D{{"species", "Ledebouria socialis"}, {"plant_id", 3}, {"height", 8.3}}}}
+
+		// Sets the upsert option to true
 		opts := options.Update().SetUpsert(true)
 
+		// Updates a documents or inserts a document if no documents are
+		// matched and prints the results
 		result, err := coll.UpdateOne(context.TODO(), filter, update, opts)
 		if err != nil {
 			panic(err)

source/includes/fundamentals/code-snippets/aggregation.go

@@ -1,3 +1,4 @@
+// Performs an aggregation by using the Go driver
 package main
 
 import (
@@ -39,6 +40,7 @@ func main() {
 		}
 	}()
 
+	// Inserts sample documents describing tea varieties
 	// begin insert docs
 	coll := client.Database("tea").Collection("menu")
 	docs := []interface{}{
@@ -63,13 +65,17 @@ func main() {
 
 	fmt.Println("\nAggregation Example - Average\n")
 	{
+		// Creates a stage to group documents by "category" and
+		// calculates the average price and total number of documents
+		// for each "category"
 		groupStage := bson.D{
 			{"$group", bson.D{
 				{"_id", "$category"},
 				{"average_price", bson.D{{"$avg", "$price"}}},
 				{"type_total", bson.D{{"$sum", 1}}},
 			}}}
 
+		// Performs the aggregation and prints the results
 		cursor, err := coll.Aggregate(context.TODO(), mongo.Pipeline{groupStage})
 		if err != nil {
 			panic(err)
@@ -87,11 +93,14 @@ func main() {
 
 	fmt.Println("\nAggregation Example - Unset\n")
 	{
+		// Creates stages to match documents, remove the "category"
+		// field, specify a sort, and limit the output to 2 documents
 		matchStage := bson.D{{"$match", bson.D{{"toppings", "milk foam"}}}}
 		unsetStage := bson.D{{"$unset", bson.A{"_id", "category"}}}
 		sortStage := bson.D{{"$sort", bson.D{{"price", 1}, {"toppings", 1}}}}
 		limitStage := bson.D{{"$limit", 2}}
 
+		// Performs the aggregation and prints the results
 		cursor, err := coll.Aggregate(context.TODO(), mongo.Pipeline{matchStage, unsetStage, sortStage, limitStage})
 		if err != nil {
 			panic(err)

source/includes/fundamentals/code-snippets/gridfs.go

@@ -1,3 +1,4 @@
+// Stores and retrieves large files by using the Go driver GridFS feature
 package main
 
 import (
@@ -20,6 +21,7 @@ func main() {
 	}
 	defer client.Disconnect(context.TODO())
 
+	// Creates a GridFS bucket
 	bucket, err := gridfs.NewBucket(client.Database("foo"))
 	if err != nil {
 		panic(err)
@@ -30,7 +32,12 @@ func main() {
 	if err != nil {
 		panic(err)
 	}
+
+	// Defines options that specify configuration information for files
+	// uploaded to the bucket
 	uploadOpts := options.GridFSUpload().SetChunkSizeBytes(200000)
+
+	// Writes a file to an output stream
 	uploadStream, err := bucket.OpenUploadStream("file.txt", uploadOpts)
 	if err != nil {
 		panic(err)

source/includes/fundamentals/code-snippets/logging.go

@@ -1,3 +1,4 @@
+// Configures loggers by using the Go driver
 package main
 
 import (
@@ -31,12 +32,14 @@ func main() {
 }
 
 func standardLogging(uri string) {
+	// Sets options when configuring the standard logger
 	// start-standard-logger
 	loggerOptions := options.
 		Logger().
 		SetMaxDocumentLength(25).
 		SetComponentLevel(options.LogComponentCommand, options.LogLevelDebug)
 
+	// Creates options that include the logger specification
 	clientOptions := options.
 		Client().
 		ApplyURI(uri).
@@ -63,6 +66,7 @@ func standardLogging(uri string) {
 	}
 }
 
+// Creates a struct to model the logger
 // start-customlogger-struct
 type CustomLogger struct {
 	io.Writer
@@ -71,6 +75,7 @@ type CustomLogger struct {
 
 // end-customlogger-struct
 
+// Creates functions to specify how the logger generates messages
 // start-customlogger-funcs
 func (logger *CustomLogger) Info(level int, msg string, _ ...interface{}) {
 	logger.mu.Lock()
@@ -91,6 +96,7 @@ func (logger *CustomLogger) Error(err error, msg string, _ ...interface{}) {
 // end-customlogger-funcs
 
 func customLogging(uri string) {
+	// Sets options when configuring the custom logger
 	// start-set-customlogger
 	buf := bytes.NewBuffer(nil)
 	sink := &CustomLogger{Writer: buf}
@@ -101,11 +107,12 @@ func customLogging(uri string) {
 		SetComponentLevel(options.LogComponentCommand, options.LogLevelDebug).
 		SetComponentLevel(options.LogComponentConnection, options.LogLevelDebug)
 
+	// Creates options that include the logger specification
 	clientOptions := options.
 		Client().
 		ApplyURI(uri).
 		SetLoggerOptions(loggerOptions)
-		// end-set-customlogger
+	// end-set-customlogger
 	client, err := mongo.Connect(context.TODO(), clientOptions)
 	if err != nil {
 		panic(err)
@@ -126,6 +133,7 @@ func customLogging(uri string) {
 }
 
 func thirdPartyLogging(uri string) {
+	// Creates a logrus logger
 	// start-make-logrus
 	myLogger := &logrus.Logger{
 		Out:   os.Stderr,
@@ -137,19 +145,22 @@ func thirdPartyLogging(uri string) {
 	}
 	// end-make-logrus
 
+	// Sets the sink for the logger
 	// start-set-thirdparty-logger
 	sink := logrusr.New(myLogger).GetSink()
 
+	// Sets options when configuring the logrus logger
 	loggerOptions := options.
 		Logger().
 		SetSink(sink).
 		SetComponentLevel(options.LogComponentCommand, options.LogLevelDebug)
 
+	// Creates options that include the logger specification
 	clientOptions := options.
 		Client().
 		ApplyURI(uri).
 		SetLoggerOptions(loggerOptions)
-		// end-set-thirdparty-logger
+	// end-set-thirdparty-logger
 	client, err := mongo.Connect(context.TODO(), clientOptions)
 	if err != nil {
 		panic(err)