[C#] CodeWhisperer Code Comments - Part 4 (#154)

* Codewhisperer comments p4

Author: rachel-mack

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

@@ -96,15 +96,15 @@ The {+driver-short+} provides a ``Builders`` class that simplifies the creation
 query filters and update documents. The following code sample uses ``Builders`` to create
 two documents for use as parameters in an update operation:
 
-- A query filter that searches for restaurants with a ``borough`` field value of "Manhattan" 
-- An update document that sets the value of the ``borough`` field of these restaurants 
-  to "Manhattan (north)"
+- A query filter that searches for restaurants with a ``cuisine`` field value of "Pizza" 
+- An update document that sets the value of the ``cuisine`` field of these restaurants 
+  to "Pasta and breadsticks"
 
-.. literalinclude:: /includes/fundamentals/code-examples/crud/change/Update.cs
+.. literalinclude:: /includes/code-examples/update-many/UpdateMany.cs
    :language: csharp
    :dedent:
-   :start-after: start-builders
-   :end-before: end-builders
+   :start-after: // start-update-many
+   :end-before: // end-update-many
 
 .. tip:: Aggregation Pipelines in Update Operations
 

source/includes/code-examples/update-many/UpdateMany.cs

@@ -1,3 +1,5 @@
+// Updates documents that match a query filter by using the C# driver
+
 using MongoDB.Bson.Serialization.Conventions;
 using MongoDB.Driver;
 
@@ -16,20 +18,20 @@ public static void Main(string[] args)
     {
         Setup();
 
-        // Extra space for console readability 
+        // Prints extra space for console readability  
         Console.WriteLine();
 
-        // Number of restaurants with old cuisine
+        // Finds the number of restaurants with a "cuisine" value of "Pizza"
         Console.WriteLine($"Restaurants with {CuisineField} \"{OldCuisine}\" found: {FindCountOfRestaurantsWithCuisine(OldCuisine)}");
 
-        // Update many documents synchronously
+        // Updates many documents by using a helper method
         var syncResult = UpdateManyRestaurants();
         Console.WriteLine($"Restaurants modified by update: {syncResult.ModifiedCount}");
 
-        // Number of restaurants with new cuisine
+        // Finds the number of restaurants with a "cuisine" value of "Pasta and breadsticks"
         Console.WriteLine($"Restaurants with {CuisineField} \"{NewCuisine}\" found after update: {FindCountOfRestaurantsWithCuisine(NewCuisine)}");
 
-        // Reset sample data
+        // Resets the sample data
         Console.WriteLine("Resetting sample data...");
         ResetSampleData();
         Console.WriteLine("done.");
@@ -41,12 +43,16 @@ private static UpdateResult UpdateManyRestaurants()
         const string oldValue = "Pizza";
         const string newValue = "Pasta and breadsticks";
 
-        var filter = Builders<Restaurant>.Filter
+       // Creates a filter for all documents with a "cuisine" value of "Pizza"
+       var filter = Builders<Restaurant>.Filter
             .Eq(restaurant => restaurant.Cuisine, oldValue);
 
+        // Creates instructions to update the "cuisine" field of documents that
+        // match the filter
         var update = Builders<Restaurant>.Update
             .Set(restaurant => restaurant.Cuisine, newValue);
 
+        // Updates all documents that have a "cuisine" value of "Pizza"
         return _restaurantsCollection.UpdateMany(filter, update);
         // end-update-many
     }
@@ -61,11 +67,11 @@ private static long FindCountOfRestaurantsWithCuisine(string cuisineValue)
 
     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 "sample_restaurants" collection
         var mongoClient = new MongoClient(MongoConnectionString);
         var restaurantsDatabase = mongoClient.GetDatabase("sample_restaurants");
         _restaurantsCollection = restaurantsDatabase.GetCollection<Restaurant>("restaurants");

source/includes/code-examples/update-many/UpdateManyAsync.cs

@@ -1,3 +1,5 @@
+// Asynchronously updates documents that match a query filter by using the C# driver
+
 using MongoDB.Bson.Serialization.Conventions;
 using MongoDB.Driver;
 
@@ -16,20 +18,20 @@ public static async Task Main(string[] args)
     {
         Setup();
 
-        // Extra space for console readability 
+        // Prints extra space for console readability
         Console.WriteLine();
 
-        // Number of restaurants with old cuisine
+        // Finds the number of restaurants with a "cuisine" value of "Pizza"
         Console.WriteLine($"Restaurants with {CuisineField} \"{OldCuisine}\" found: {FindCountOfRestaurantsWithCuisine(OldCuisine)}");
 
-        // Update many documents synchronously
+        // Asynchronously updates many documents by using a helper method
         var asyncResult = await UpdateManyRestaurantsAsync();
         Console.WriteLine($"Restaurants modified by update: {asyncResult.ModifiedCount}");
 
-        // Number of restaurants with new cuisine
+        // Finds the number of restaurants with a "cuisine" value of "Pasta and breadsticks"
         Console.WriteLine($"Restaurants with {CuisineField} \"{NewCuisine}\" found after update: {FindCountOfRestaurantsWithCuisine(NewCuisine)}");
 
-        // Reset sample data
+        // Resets the sample data
         Console.WriteLine("Resetting sample data...");
         ResetSampleData();
         Console.WriteLine("done.");
@@ -41,12 +43,16 @@ private static async Task<UpdateResult> UpdateManyRestaurantsAsync()
         const string oldValue = "Pizza";
         const string newValue = "Pasta and breadsticks";
 
-        var filter = Builders<Restaurant>.Filter
+        // Creates a filter for all documents with a "cuisine" value of "Pizza"
+       var filter = Builders<Restaurant>.Filter
             .Eq(restaurant => restaurant.Cuisine, oldValue);
 
+        // Creates instructions to update the "cuisine" field of documents that
+        // match the filter
         var update = Builders<Restaurant>.Update
             .Set(restaurant => restaurant.Cuisine, newValue);
 
+        // Updates all documents that have a "cuisine" value of "Pizza"
         return await _restaurantsCollection.UpdateManyAsync(filter, update);
         // end-update-many-async
     }
@@ -61,11 +67,11 @@ private static long FindCountOfRestaurantsWithCuisine(string cuisineValue)
 
     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 "sample_restaurants" collection
         var mongoClient = new MongoClient(MongoConnectionString);
         var restaurantsDatabase = mongoClient.GetDatabase("sample_restaurants");
         _restaurantsCollection = restaurantsDatabase.GetCollection<Restaurant>("restaurants");

source/includes/code-examples/update-one/UpdateOne.cs

@@ -1,3 +1,5 @@
+// Updates the first document that matches a query filter by using the C# driver
+
 using MongoDB.Bson.Serialization.Conventions;
 using MongoDB.Driver;
 
@@ -12,10 +14,10 @@ public static void Main(string[] args)
     {
         Setup();
 
-        // Extra space for console readability 
+        // Prints extra space for console readability 
         Console.WriteLine();
 
-        // Update one document synchronously
+        // Updates one document by using a helper method
         var syncResult = UpdateOneRestaurant();
         Console.WriteLine($"Updated documents: {syncResult.ModifiedCount}");
         ResetSampleData();
@@ -27,23 +29,27 @@ private static UpdateResult UpdateOneRestaurant()
         const string oldValue = "Bagels N Buns";
         const string newValue = "2 Bagels 2 Buns";
 
+        // Creates a filter for all documents with a "name" of "Bagels N Buns"
         var filter = Builders<Restaurant>.Filter
             .Eq(restaurant => restaurant.Name, oldValue);
 
+        // Creates instructions to update the "name" field of the first document
+        // that matches the filter
         var update = Builders<Restaurant>.Update
             .Set(restaurant => restaurant.Name, newValue);
 
+        // Updates the first document that has a "name" value of "Bagels N Buns"
         return _restaurantsCollection.UpdateOne(filter, update);
         // end-update-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 "sample_restaurants" collection
         var mongoClient = new MongoClient(MongoConnectionString);
         var restaurantsDatabase = mongoClient.GetDatabase("sample_restaurants");
         _restaurantsCollection = restaurantsDatabase.GetCollection<Restaurant>("restaurants");

source/includes/code-examples/update-one/UpdateOneAsync.cs

@@ -1,3 +1,5 @@
+// Asynchronously updates the first document that matches a query filter by using the C# driver
+
 using MongoDB.Bson.Serialization.Conventions;
 using MongoDB.Driver;
 
@@ -12,10 +14,10 @@ public static async Task Main(string[] args)
     {
         Setup();
 
-        // Extra space for console readability 
+        // Prints extra space for console readability 
         Console.WriteLine();
 
-        //Update one document asynchronously
+        // Updates one document asynchronously by using a helper method
         var asyncResult = await UpdateOneRestaurantAsync();
         Console.WriteLine($"Updated documents: {asyncResult.ModifiedCount}");
         ResetSampleData();
@@ -27,23 +29,27 @@ private static async Task<UpdateResult> UpdateOneRestaurantAsync()
         const string oldValue = "Bagels N Buns";
         const string newValue = "2 Bagels 2 Buns";
 
+        // Creates a filter for all documents with a "name" of "Bagels N Buns"
         var filter = Builders<Restaurant>.Filter
             .Eq(restaurant => restaurant.Name, oldValue);
 
+        // Creates instructions to update the "name" field of the first document
+        // that matches the filter
         var update = Builders<Restaurant>.Update
             .Set(restaurant => restaurant.Name, newValue);
 
+        // Updates the first document that has a "name" value of "Bagels N Buns"
         return await _restaurantsCollection.UpdateOneAsync(filter, update);
         // end-update-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 "sample_restaurants" collection
         var mongoClient = new MongoClient(MongoConnectionString);
         var restaurantsDatabase = mongoClient.GetDatabase("sample_restaurants");
         _restaurantsCollection = restaurantsDatabase.GetCollection<Restaurant>("restaurants");