conventionpack note and removing object in models (#60)

jordan-smith721 · web-flow · commit 15b0746292c1 · 2023-01-17T11:46:42.000-08:00
diff --git a/source/fundamentals/crud/read-operations/retrieve.txt b/source/fundamentals/crud/read-operations/retrieve.txt
@@ -32,6 +32,8 @@ The following ``Restaurants`` class models the documents in this collection:
    :copyable:
    :dedent:
 
+.. include:: /includes/convention-pack-note.rst
+
 .. _csharp-retrieve-find:
 
 Find Documents
diff --git a/source/fundamentals/crud/read-operations/specify-query.txt b/source/fundamentals/crud/read-operations/specify-query.txt
@@ -46,6 +46,15 @@ The following ``Guitar`` class models the documents in this collection.
    :copyable:
    :dedent:
 
+.. note::
+
+   The documents in the ``guitars`` collection use the camel-case naming
+   convention. The examples in this guide use a ``ConventionPack``
+   to deserialize the fields in the collection into Pascal case and map them to
+   the properties in the ``Guitar`` class.
+
+   To learn more about custom serialization, see :ref:`csharp-custom-serialization`.
+
 To learn more about class mapping, see :ref:`csharp-class-mapping`.
 
 The following code instantiates the ``_guitarsCollection`` object using the 
diff --git a/source/fundamentals/crud/write-operations/change.txt b/source/fundamentals/crud/write-operations/change.txt
@@ -34,6 +34,8 @@ collection use the following ``Restaurant`` class as a model:
    :start-after: start-model
    :end-before: end-model
 
+.. include:: /includes/convention-pack-note.rst
+
 This collection is from the :atlas:`sample datasets </sample-data>` provided
 by Atlas. See the :ref:`<csharp-quickstart>` to learn how to create a free MongoDB cluster
 and load this sample data.
diff --git a/source/fundamentals/crud/write-operations/delete.txt b/source/fundamentals/crud/write-operations/delete.txt
@@ -31,6 +31,8 @@ collection are modeled by the following ``Restaurant`` class:
    :start-after: start-model
    :end-before: end-model
 
+.. include:: /includes/convention-pack-note.rst
+
 This collection is from the :atlas:`sample datasets </sample-data>` provided
 by Atlas. See the :ref:`<csharp-quickstart>` to learn how to create a free MongoDB cluster
 and load this sample data.
diff --git a/source/fundamentals/crud/write-operations/insert.txt b/source/fundamentals/crud/write-operations/insert.txt
@@ -31,6 +31,8 @@ example are modeled by the following ``Restaurant`` class:
    :start-after: start-model
    :end-before: end-model
 
+.. include:: /includes/convention-pack-note.rst
+
 This collection is from the :atlas:`sample datasets </sample-data>` provided
 by Atlas. See the :ref:`<csharp-quickstart>` to learn how to create a free MongoDB cluster
 and load this sample data.
diff --git a/source/fundamentals/linq.txt b/source/fundamentals/linq.txt
@@ -47,14 +47,7 @@ documents in this collection:
    :start-after: start-grade-model
    :end-before: end-grade-model
 
-.. note::
-
-   The documents in the ``restaurants`` collection use the camel
-   case naming convention. The examples in this guide use a ``ConventionPack``
-   to deserialize the fields in the collection into Pascal case and map them to
-   the properties in the ``Restaurant`` class.
-
-   To learn more about custom serialization see :ref:`csharp-custom-serialization`.
+.. include:: /includes/convention-pack-note.rst
 
 .. _csharp-linq-queryable:
 
diff --git a/source/includes/code-examples/delete-many/Restaurant.cs b/source/includes/code-examples/delete-many/Restaurant.cs
@@ -15,10 +15,10 @@ public class Restaurant
 
     public string Cuisine { get; set; }
 
-    public object Address { get; set; }
+    public Address Address { get; set; }
 
     public string Borough { get; set; }
 
-    public List<object> Grades { get; set; }
+    public List<GradeEntry> Grades { get; set; }
 }
 // end-model
diff --git a/source/includes/code-examples/delete-one/Restaurant.cs b/source/includes/code-examples/delete-one/Restaurant.cs
@@ -15,10 +15,10 @@ public class Restaurant
 
     public string Cuisine { get; set; }
 
-    public object Address { get; set; }
+    public Address Address { get; set; }
 
     public string Borough { get; set; }
 
-    public List<object> Grades { get; set; }
+    public List<GradeEntry> Grades { get; set; }
 }
 // end-model
diff --git a/source/includes/code-examples/find-many/Restaurant.cs b/source/includes/code-examples/find-many/Restaurant.cs
@@ -15,10 +15,10 @@ public class Restaurant
 
     public string Cuisine { get; set; }
 
-    public object Address { get; set; }
+    public Address Address { get; set; }
 
     public string Borough { get; set; }
 
-    public List<object> Grades { get; set; }
+    public List<GradeEntry> Grades { get; set; }
 }
 // end-model
diff --git a/source/includes/code-examples/find-one/Restaurant.cs b/source/includes/code-examples/find-one/Restaurant.cs
@@ -15,10 +15,10 @@ public class Restaurant
 
     public string Cuisine { get; set; }
 
-    public object Address { get; set; }
+    public Address Address { get; set; }
 
     public string Borough { get; set; }
 
-    public List<object> Grades { get; set; }
+    public List<GradeEntry> Grades { get; set; }
 }
 // end-model
diff --git a/source/includes/code-examples/insert-many/Restaurant.cs b/source/includes/code-examples/insert-many/Restaurant.cs
@@ -15,7 +15,7 @@ public class Restaurant
 
     public string Cuisine { get; set; }
 
-    public object Address { get; set; }
+    public Address Address { get; set; }
 
     public string Borough { get; set; }
 }
diff --git a/source/includes/code-examples/insert-one/Restaurant.cs b/source/includes/code-examples/insert-one/Restaurant.cs
@@ -15,7 +15,7 @@ public class Restaurant
 
     public string Cuisine { get; set; }
 
-    public object Address { get; set; }
+    public Address Address { get; set; }
 
     public string Borough { get; set; }
 }
diff --git a/source/includes/code-examples/replace-one/Restaurant.cs b/source/includes/code-examples/replace-one/Restaurant.cs
@@ -15,10 +15,10 @@ public class Restaurant
 
     public string Cuisine { get; set; }
 
-    public object Address { get; set; }
+    public Address Address { get; set; }
 
     public string Borough { get; set; }
 
-    public List<object> Grades { get; set; }
+    public List<GradeEntry> Grades { get; set; }
 }
 //end-model
diff --git a/source/includes/code-examples/update-one/Restaurant.cs b/source/includes/code-examples/update-one/Restaurant.cs
@@ -15,10 +15,10 @@ public class Restaurant
 
     public string Cuisine { get; set; }
 
-    public object Address { get; set; }
+    public Address Address { get; set; }
 
     public string Borough { get; set; }
 
-    public List<object> Grades { get; set; }
+    public List<GradeEntry> Grades { get; set; }
 }
 // end-model
diff --git a/source/includes/convention-pack-note.rst b/source/includes/convention-pack-note.rst
@@ -0,0 +1,8 @@
+.. note::
+
+   The documents in the ``restaurants`` collection use the camel-case naming
+   convention. The examples in this guide use a ``ConventionPack``
+   to deserialize the fields in the collection into Pascal case and map them to
+   the properties in the ``Restaurant`` class.
+
+   To learn more about custom serialization, see :ref:`csharp-custom-serialization`.
diff --git a/source/includes/fundamentals/code-examples/crud/Restaurant.cs b/source/includes/fundamentals/code-examples/crud/Restaurant.cs
@@ -7,5 +7,5 @@ public class Restaurant
 
     public string Cuisine { get; set; }
 
-    public object Address { get; set; }
+    public Address Address { get; set; }
 }
diff --git a/source/includes/fundamentals/code-examples/crud/change/Restaurant.cs b/source/includes/fundamentals/code-examples/crud/change/Restaurant.cs
@@ -10,8 +10,8 @@ public class Restaurant
     [BsonElement("restaurant_id")]
     public string RestaurantId { get; set; }
     public string Cuisine { get; set; }
-    public object Address { get; set; }
+    public Address Address { get; set; }
     public string Borough { get; set; }
-    public List<object> Grades { get; set; }
+    public List<GradeEntry> Grades { get; set; }
 }
 // end-model
diff --git a/source/includes/fundamentals/code-examples/crud/delete.cs b/source/includes/fundamentals/code-examples/crud/delete.cs
@@ -46,8 +46,8 @@ public class Restaurant
     [BsonElement("restaurant_id")]
     public string RestaurantId { get; set; }
     public string Cuisine { get; set; }
-    public object Address { get; set; }
+    public Address Address { get; set; }
     public string Borough { get; set; }
-    public List<object> Grades { get; set; }
+    public List<GradeEntry> Grades { get; set; }
 }
 // end-model
diff --git a/source/usage-examples/deleteMany.txt b/source/usage-examples/deleteMany.txt
@@ -27,6 +27,8 @@ These examples use the following ``Restaurant`` class as a model:
    :copyable:
    :dedent:
 
+.. include:: /includes/convention-pack-note.rst
+
 The following code deletes all documents in the ``restaurants`` collection whose 
 ``borough`` field value equals the word "Brooklyn".
 
diff --git a/source/usage-examples/deleteOne.txt b/source/usage-examples/deleteOne.txt
@@ -34,6 +34,8 @@ These examples use the following ``Restaurant`` class as a model:
    :copyable:
    :dedent:
 
+.. include:: /includes/convention-pack-note.rst
+
 Delete a Document Using Builders
 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
 
diff --git a/source/usage-examples/findMany.txt b/source/usage-examples/findMany.txt
@@ -27,6 +27,8 @@ These examples use the following ``Restaurant`` class as a model:
    :copyable:
    :dedent:
 
+.. include:: /includes/convention-pack-note.rst
+
 Find Documents Using Builders
 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ 
 
diff --git a/source/usage-examples/findOne.txt b/source/usage-examples/findOne.txt
@@ -26,6 +26,8 @@ These examples use the following ``Restaurant`` class as a model:
    :copyable:
    :dedent:
 
+.. include:: /includes/convention-pack-note.rst
+
 Find a Document Using Builders
 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
 
diff --git a/source/usage-examples/insertMany.txt b/source/usage-examples/insertMany.txt
@@ -26,6 +26,8 @@ This example uses the following ``Restaurant`` class as a model:
    :language: csharp
    :copyable:
    :dedent:
+
+.. include:: /includes/convention-pack-note.rst
       
 The following example inserts multiple documents into 
 the ``restaurants`` collection.
diff --git a/source/usage-examples/insertOne.txt b/source/usage-examples/insertOne.txt
@@ -27,6 +27,8 @@ These examples use the following ``Restaurant`` class as a model:
    :copyable:
    :dedent:
 
+.. include:: /includes/convention-pack-note.rst
+
 The following example inserts a document into 
 the ``restaurants`` collection.
 
diff --git a/source/usage-examples/replaceOne.txt b/source/usage-examples/replaceOne.txt
@@ -27,6 +27,8 @@ This example uses the following ``Restaurant`` class as a model:
    :copyable:
    :dedent:
 
+.. include:: /includes/convention-pack-note.rst
+
 The following code replaces the first document in the ``restaurants`` collection that has a 
 value of "Pizza" in the ``cuisine`` field. After the replacement, this document will 
 have a ``name`` field with a value of "Mongo's Pizza" and new values for the 
diff --git a/source/usage-examples/updateMany.txt b/source/usage-examples/updateMany.txt
@@ -27,6 +27,8 @@ This example uses the following ``Restaurant`` class as a model:
    :copyable:
    :dedent:
 
+.. include:: /includes/convention-pack-note.rst
+
 The following code updates all documents in the ``restaurants`` collection that have a 
 ``cuisine`` field with the value of "Pizza". After the update, these documents will 
 have a ``cuisine`` field with a value of "Pasta and breadsticks".
diff --git a/source/usage-examples/updateOne.txt b/source/usage-examples/updateOne.txt
@@ -37,6 +37,8 @@ These examples use the following ``Restaurant`` class as a model:
    :copyable:
    :dedent:
 
+.. include:: /includes/convention-pack-note.rst
+
 The following example uses ``Builders`` to update the ``name`` of the
 first document named "Bagels N Buns" in the ``restaurants`` collection  to 
 "2 Bagels 2 Buns".

Original file line number	Diff line number	Diff line change
`@@ -15,10 +15,10 @@ public class Restaurant`
`15`	`15`
`16`	`16`	`public string Cuisine { get; set; }`
`17`	`17`
`18`		`- public object Address { get; set; }`
	`18`	`+ public Address Address { get; set; }`
`19`	`19`
`20`	`20`	`public string Borough { get; set; }`
`21`	`21`
`22`		`- public List<object> Grades { get; set; }`
	`22`	`+ public List<GradeEntry> Grades { get; set; }`
`23`	`23`	`}`
`24`	`24`	`// end-model`