[C#] CodeWhisperer Code Comments - Part 7 (#159)

* Codewhisperer comments p7

Author: rachel-mack

source/fundamentals/connection/connect.txt

@@ -4,7 +4,12 @@
 Connection Guide
 ================
 
-.. default-domain:: mongodb
+.. facet::
+   :name: genre
+   :values: reference
+
+.. meta::
+   :keywords: connection string, URI, server, Atlas, settings
 
 .. contents:: On this page
    :local:
@@ -64,6 +69,8 @@ instance on port ``27017`` of ``localhost``:
 
 .. literalinclude:: /includes/fundamentals/code-examples/connection/LocalConnection.cs
    :language: csharp
+   :start-after: // start local connection
+   :end-before: // end local connection
 
 .. tip:: Reuse Your Client
 
@@ -88,6 +95,8 @@ MongoDB instance on port ``27017`` of ``localhost``:
 .. literalinclude:: /includes/fundamentals/code-examples/connection/MongoClientSettings.cs
    :language: csharp
    :dedent:
+   :start-after: // start mongo client settings
+   :end-before: // end mongo client settings
 
 Other Connection Targets
 ------------------------
@@ -115,6 +124,8 @@ deployment and verify that the connection is successful:
 
 .. literalinclude:: /includes/fundamentals/code-examples/connection/AtlasConnection.cs
    :language: csharp
+   :start-after: // start atlas connection
+   :end-before: // end atlas connection
 
 .. tip::
 
@@ -141,3 +152,5 @@ hosts, including ``sample.host1``:
 
 .. literalinclude:: /includes/fundamentals/code-examples/connection/ReplicaSetConnection.cs
    :language: csharp
+   :start-after: // start replica set connection
+   :end-before: // end replica set connection

source/fundamentals/connection/connection-options.txt

@@ -4,6 +4,13 @@
 Connection Options
 ==================
 
+.. facet::
+   :name: genre
+   :values: reference
+
+.. meta::
+   :keywords: connection string, URI, server, Atlas, settings, configure
+
 .. contents:: On this page
    :local:
    :backlinks: none
@@ -28,6 +35,8 @@ and the ``tls`` option with a value of ``true``:
 .. literalinclude:: /includes/fundamentals/code-examples/connection/LocalConnectionConfig.cs
    :language: csharp
    :dedent:
+   :start-after: // start local connection config
+   :end-before: // end local connection config
 
 .. _csharp-mongo-client-settings:
 
@@ -46,6 +55,8 @@ its properties, and pass it as an argument to the ``MongoClient`` constructor:
 .. literalinclude:: /includes/fundamentals/code-examples/connection/MongoClientSettingsConfig.cs
    :language: csharp
    :dedent:
+   :start-after: // start mongo client settings config
+   :end-before: // end mongo client settings config
 
 Connection Options
 ------------------

source/fundamentals/crud/read-operations/count.txt

@@ -219,7 +219,7 @@ The following example performs the following actions:
       :language: none
       :visible: false
 
-      Number of documents with a final grade more than 80: 2
+      Number of documents with a final grade more than 80: 4
 
 
 Additional Information

source/includes/fundamentals/code-examples/Bson.cs

@@ -1,3 +1,5 @@
+// Modifies a BSON document by using the C# driver
+
 using MongoDB.Driver;
 
 namespace DataFormats.Bson;
@@ -6,6 +8,8 @@ public class Bson
 {
     public static void Main(string[] args)
     {
+        // Creates a new document, adds "restaurant_id" field, removes the
+        // "cuisine" field and sets the "name" value
         //start-create
         var newRestaurant = new BsonDocument
         {

source/includes/fundamentals/code-examples/CountDocuments.cs

@@ -1,3 +1,6 @@
+// Counts the number of documents in a collection and after
+// applying a filter by using the C# driver
+
 using MongoDB.Bson.Serialization.Conventions;
 using MongoDB.Driver;
 namespace TestRun.Fundamentals;
@@ -10,17 +13,20 @@ public static void Main(string[] args)
         Setup();
         InsertSampleData();
 
+        // Finds and counts all documents with a "finalGrade" value less than 80
         // start-accurate-ct
         var filter = Builders<Student>.Filter.Lt(s => s.FinalGrade, 80.0);
         var count1 = _myColl.CountDocuments(filter);
         Console.WriteLine("Number of documents with a final grade less than 80: " + count1);
         // end-accurate-ct
 
-        // start-est-count
+        // Finds the total number of documents in the collection
+        //  start-est-count
         var count2 = _myColl.EstimatedDocumentCount();
         Console.WriteLine("Estimated number of documents in the students collection: " + count2);
         // end-est-count
 
+        // Finds the number of documents with a "finalGrade" value greater than 80
         // start-agg-count
         var matchStage = Builders<Student>
             .Filter.Gt(s => s.FinalGrade, 80);

source/includes/fundamentals/code-examples/atlas-search/AtlasSearchExamples.cs

@@ -1,3 +1,5 @@
+// Performs Atlas Search queries by using the C# driver 
+
 using MongoDB.Bson;
 using MongoDB.Bson.Serialization.Attributes;
 using MongoDB.Bson.Serialization.Conventions;
@@ -14,7 +16,6 @@ public static void Main(string[] args)
     {
         Setup();
 
-        // Call method here to test
         var results = AutocompleteSearch();
 
         foreach (var g in results)
@@ -25,6 +26,7 @@ public static void Main(string[] args)
 
     public static List<Guitar> AutocompleteSearch()
     {
+        // Finds documents with a "make" value that contains the string fragment "Gib"
         // start-autocomplete-search
         var result = guitarsCollection.Aggregate()
             .Search(Builders<Guitar>.Search.Autocomplete(g => g.Make, "Gib"))
@@ -36,6 +38,8 @@ public static List<Guitar> AutocompleteSearch()
 
     public static List<Guitar> CompoundSearch()
     {
+        // Find documents that meet multiple search criteria by using the
+        // Compound() search function
         // start-compound-search
         var result = guitarsCollection.Aggregate()
             .Search(Builders<Guitar>.Search.Compound()

source/includes/fundamentals/code-examples/connection/AtlasConnection.cs

@@ -1,3 +1,6 @@
+// Defines a template for connecting to a server through Atlas
+
+// start atlas connection
 using MongoDB.Driver;
 using MongoDB.Bson;
 
@@ -6,14 +9,15 @@
 
 var settings = MongoClientSettings.FromConnectionString(connectionUri);
 
-// Set the ServerApi field of the settings object to Stable API version 1
+// Sets the ServerApi field of the settings object to Stable API version 1
 settings.ServerApi = new ServerApi(ServerApiVersion.V1);
 
-// Create a new client and connect to the server
+// Creates a new client and connects to the server
 var client = new MongoClient(settings);
 
-// Send a ping to confirm a successful connection
+// Sends a ping to confirm a successful connection
 try {
     var result = client.GetDatabase("admin").RunCommand<BsonDocument>(new BsonDocument("ping", 1));
     Console.WriteLine("Pinged your deployment. You successfully connected to MongoDB!");
 } catch (Exception ex) { Console.WriteLine(ex);}
+// end atlas connection

source/includes/fundamentals/code-examples/connection/LocalConnection.cs

@@ -1,7 +1,11 @@
+// Defines a template for connecting to a server by using a URI
+
+// start local connection
 using MongoDB.Driver;
 
-// Connection URI
+// Sets the connection URI
 const string connectionUri = "mongodb://localhost:27017";
 
-// Create a new client and connect to the server
-var client = new MongoClient(connectionUri);
+// Creates a new client and connects to the server
+var client = new MongoClient(connectionUri);
+// end local connection

source/includes/fundamentals/code-examples/connection/LocalConnectionConfig.cs

@@ -1,7 +1,11 @@
+// Connects to a server by using a URI with configuration options
+
+// start local connection config
 using MongoDB.Driver;
 
-// Connection URI
+// Sets the connection URI
 const string connectionUri = "mongodb+srv://sample.host:27017/?connectTimeoutMS=60000&tls=true";
 
-// Create a new client and connect to the server
-var client = new MongoClient(connectionUri);
+// Creates a new client and connects to the server
+var client = new MongoClient(connectionUri);
+// end local connection config

source/includes/fundamentals/code-examples/connection/MongoClientSettings.cs

@@ -1,11 +1,15 @@
+// Defines a MongoClientSettings object to pass settings to the client
+
+// start mongo client settings
 using MongoDB.Driver;
 
-// Create a MongoClientSettings object
+// Creates a MongoClientSettings object
 var settings = new MongoClientSettings()
 {
     Scheme = ConnectionStringScheme.MongoDB,
     Server = new MongoServerAddress("localhost", 27017)
 };
 
-// Create a new client and connect to the server
-var client = new MongoClient(settings);
+// Creates a new client and connects to the server
+var client = new MongoClient(settings);
+// end mongo client settings