[C#] CodeWhisperer Code Comments - Part 3 (#152)

* Codewhisperer comment p3

Author: rachel-mack

source/fundamentals/crud/write-operations/modify.txt

@@ -10,6 +10,13 @@ Modify Documents
    :depth: 2
    :class: singlecol
 
+.. facet::
+   :name: genre
+   :values: reference
+
+.. meta::
+   :keywords: update, replace, synchronous, asynchronous, bulk
+
 Overview
 --------
 
@@ -321,11 +328,11 @@ The following code sample uses ``Builders`` to create a query filter that search
 for restaurants with a ``name`` field value of "Pizza Town". The code also creates a new 
 ``Restaurant`` object that will replace the first matched document. 
 
-.. literalinclude:: /includes/fundamentals/code-examples/crud/change/Replace.cs
+.. literalinclude:: /includes/code-examples/replace-one/ReplaceOne.cs
    :language: csharp
    :dedent:
-   :start-after: // start-parameters 
-   :end-before: // end-parameters 
+   :start-after: // start-replace-one
+   :end-before: // end-replace-one
 
 .. important::
 

source/includes/code-examples/replace-one/ReplaceOne.cs

@@ -1,3 +1,5 @@
+// Replaces the first document that matches a filter by using the C# driver
+
 using MongoDB.Bson;
 using MongoDB.Bson.Serialization.Conventions;
 using MongoDB.Driver;
@@ -13,15 +15,15 @@ public static void Main(string[] args)
     {
         Setup();
 
-        // Create filter 
+        // Creates a filter for all restaurant documents that have a "cuisine" value of "Pizza"
         var filter = Builders<Restaurant>.Filter
             .Eq(r => r.Cuisine, "Pizza");
 
-        // Find first pizza restaurant
+        // Finds the first restaurant document that matches the filter
         var oldPizzaRestaurant = _restaurantsCollection.Find(filter).First();
         Console.WriteLine($"First pizza restaurant before replacement: {oldPizzaRestaurant.Name}");
 
-        // Replace one document synchronously
+        // Replaces the document by using a helper method
         var syncResult = ReplaceOneRestaurant();
         Console.WriteLine($"Restaurants modified by replacement: {syncResult.ModifiedCount}");
 
@@ -36,13 +38,15 @@ public static void Main(string[] args)
     private static ReplaceOneResult ReplaceOneRestaurant()
     {
         // start-replace-one
+        // Creates a filter for all restaurant documents that have a "cuisine" value of "Pizza"
         var filter = Builders<Restaurant>.Filter
             .Eq(r => r.Cuisine, "Pizza");
 
-        // Find ID of first pizza restaurant
+        // Finds the ID of the first restaurant document that matches the filter
         var oldPizzaRestaurant = _restaurantsCollection.Find(filter).First();
         var oldId = oldPizzaRestaurant.Id;
 
+        // Generates a new restaurant document
         Restaurant newPizzaRestaurant = new()
         {
             Id = oldId,
@@ -56,17 +60,18 @@ private static ReplaceOneResult ReplaceOneRestaurant()
             Borough = "Manhattan",
         };
 
+        // Replaces the existing restaurant document with the new document
         return _restaurantsCollection.ReplaceOne(filter, newPizzaRestaurant);
         // end-replace-one
     }
 
     private static void Setup()
     {
-        // This allows automapping of the camelCase database fields to our models. 
+        // Allows automapping of the camelCase database fields to models 
         var camelCaseConvention = new ConventionPack { new CamelCaseElementNameConvention() };
         ConventionRegistry.Register("CamelCase", camelCaseConvention, type => true);
 
-        // Establish the connection to MongoDB and get the restaurants database
+        // Establishes the connection to MongoDB and accesses the restaurants database
         var mongoClient = new MongoClient(MongoConnectionString);
         var restaurantsDatabase = mongoClient.GetDatabase("sample_restaurants");
         _restaurantsCollection = restaurantsDatabase.GetCollection<Restaurant>("restaurants");

source/includes/code-examples/replace-one/ReplaceOneAsync.cs

@@ -1,3 +1,5 @@
+// Asynchronously replaces the first document that matches a filter by using the C# driver
+
 using MongoDB.Bson;
 using MongoDB.Bson.Serialization.Conventions;
 using MongoDB.Driver;
@@ -13,15 +15,15 @@ public static async Task Main(string[] args)
     {
         Setup();
 
-        // Create filter 
+        // Creates a filter for all restaurant documents that have a "cuisine" value of "Pizza" 
         var filter = Builders<Restaurant>.Filter
             .Eq(r => r.Cuisine, "Pizza");
 
-        // Find first pizza restaurant
+        // Finds the first restaurant document that matches the filter
         var oldPizzaRestaurant = _restaurantsCollection.Find(filter).First();
         Console.WriteLine($"First pizza restaurant before replacement: {oldPizzaRestaurant.Name}");
 
-        // Replace one document asynchronously
+        // Asynchronously replaces the document by using a helper method
         var asyncResult = await ReplaceOneRestaurant();
         Console.WriteLine($"Restaurants modified by replacement: {asyncResult.ModifiedCount}");
 
@@ -36,13 +38,15 @@ public static async Task Main(string[] args)
     private static async Task<ReplaceOneResult> ReplaceOneRestaurant()
     {
         // start-replace-one-async
+        // Creates a filter for all restaurant documents that have a "cuisine" value of "Pizza"
         var filter = Builders<Restaurant>.Filter
             .Eq(r => r.Cuisine, "Pizza");
 
-        // Find ID of first pizza restaurant
+        // Finds the ID of the first restaurant document that matches the filter
         var oldPizzaRestaurant = _restaurantsCollection.Find(filter).First();
         var oldId = oldPizzaRestaurant.Id;
 
+        // Generates a new restaurant document
         Restaurant newPizzaRestaurant = new()
         {
             Id = oldId,
@@ -56,17 +60,18 @@ private static async Task<ReplaceOneResult> ReplaceOneRestaurant()
             Borough = "Manhattan",
         };
 
+        // Asynchronously replaces the existing restaurant document with the new document
         return await _restaurantsCollection.ReplaceOneAsync(filter, newPizzaRestaurant);
         // end-replace-one-async
     }
 
     private static void Setup()
     {
-        // This allows automapping of the camelCase database fields to our models. 
+        // Allows automapping of the camelCase database fields to models  
         var camelCaseConvention = new ConventionPack { new CamelCaseElementNameConvention() };
         ConventionRegistry.Register("CamelCase", camelCaseConvention, type => true);
 
-        // Establish the connection to MongoDB and get the restaurants database
+        // Establishes the connection to MongoDB and accesses the restaurants database
         var mongoClient = new MongoClient(MongoConnectionString);
         var restaurantsDatabase = mongoClient.GetDatabase("sample_restaurants");
         _restaurantsCollection = restaurantsDatabase.GetCollection<Restaurant>("restaurants");