DOCSP-33452: V1 cleanup (#53)

norareidy · web-flow · commit 347509203451 · 2023-10-05T11:30:16.000-04:00
diff --git a/source/fundamentals/aggregation.txt b/source/fundamentals/aggregation.txt
@@ -259,7 +259,7 @@ API Documentation
 ~~~~~~~~~~~~~~~~~
 
 To learn more about any of the methods or types discussed in this
-guide, see the following API Documentation:
+guide, see the following API documentation:
 
 - `aggregate() <{+api+}/struct.Collection.html#method.aggregate>`__
 - `AggregateOptions <{+api+}/options/struct.AggregateOptions.html>`__
diff --git a/source/fundamentals/authentication.txt b/source/fundamentals/authentication.txt
@@ -322,7 +322,7 @@ API Documentation
 ~~~~~~~~~~~~~~~~~
 
 To learn more about the methods and types discussed in this
-guide, see the following API Documentation:
+guide, see the following API documentation:
 
 - `Credential <{+api+}/options/struct.Credential.html>`__
 - `ClientOptions <{+api+}/options/struct.ClientOptions.html>`__
diff --git a/source/fundamentals/crud/compound-operations.txt b/source/fundamentals/crud/compound-operations.txt
@@ -526,7 +526,7 @@ API Documentation
 ~~~~~~~~~~~~~~~~~
 
 To learn more about the methods and types discussed in this
-guide, see the following API Documentation:
+guide, see the following API documentation:
 
 - `find_one_and_delete() <{+api+}/struct.Collection.html#method.find_one_and_delete>`__
 - `FindOneAndDeleteOptions <{+api+}/options/struct.FindOneAndDeleteOptions.html>`__
diff --git a/source/fundamentals/crud/read-operations/cursor.txt b/source/fundamentals/crud/read-operations/cursor.txt
@@ -243,6 +243,13 @@ the method that returns the ``Cursor`` instance. For example, you can
 specify cursor-related options in a ``FindOptions`` type that you pass to the
 ``find()`` method.
 
+.. note:: Instantiating Options
+   
+   The {+driver-short+} implements the Builder design pattern for the
+   creation of many different types, including ``FindOptions``. You can
+   use each type's ``builder()`` method to construct an options instance
+   by chaining option builder functions one at a time.
+
 The following table describes cursor-related options that you can set in
 an options instance:
 
diff --git a/source/fundamentals/crud/read-operations/query.txt b/source/fundamentals/crud/read-operations/query.txt
@@ -394,7 +394,7 @@ API Documentation
 ~~~~~~~~~~~~~~~~~
 
 To learn more about any of the methods or types used in this
-guide, see the following API Documentation:
+guide, see the following API documentation:
 
 - `find() <{+api+}/struct.Collection.html#method.find>`__
 - `Cursor <{+api+}/struct.Cursor.html>`__
diff --git a/source/fundamentals/crud/read-operations/retrieve.txt b/source/fundamentals/crud/read-operations/retrieve.txt
@@ -206,18 +206,8 @@ following parameters:
       :language: console
       :visible: false
 
-      { 
-        "_id": { ... },
-        "item": "watering can",
-        "category": "garden",
-        "unit_price": 11.99
-      }
-      {
-        "_id": { ... },
-        "item": "candle",
-        "category": "decor",
-        "unit_price": 2.89
-      }
+      { "_id": { ... }, "item": "watering can", "category": "garden", "unit_price": 11.99 }
+      { "_id": { ... }, "item": "candle", "category": "decor", "unit_price": 2.89 }
 
 .. _rust-find-one-example:
 
@@ -244,12 +234,22 @@ following parameters:
       :language: console
       :visible: false
 
-      {
-        "_id": { ... },
-        "item": "watering can",
-        "category": "garden",
-        "unit_price": 11.99
-      }
+      Some(
+        Document({
+            "_id": ObjectId(
+                "...",
+            ),
+            "item": String(
+                "watering can",
+            ),
+            "category": String(
+                "garden",
+            ),
+            "unit_price": Double(
+                11.99,
+            ),
+        }),
+      )
 
 .. _rust-retrieve-aggregation:
 
@@ -356,18 +356,9 @@ pipeline that contains the following stages:
       :language: console
       :visible: false
 
-      {
-        "_id": { "category": "garden" },
-        "avg_price": 11.99
-      }
-      {
-        "_id": { "category": "decor" },
-        "avg_price": 2.89
-      }
-      {
-        "_id": { "category": "kitchen" },
-        "avg_price": 20.84
-      }
+      { "_id": { "category": "garden" }, "avg_price": 11.99 }
+      { "_id": { "category": "decor" }, "avg_price": 2.89 }
+      { "_id": { "category": "kitchen" }, "avg_price": 20.84 }
 
 .. _rust-crud-retrieve-addtl-info:
 
@@ -397,7 +388,7 @@ API Documentation
 ~~~~~~~~~~~~~~~~~
 
 To learn more about the methods and types discussed in this
-guide, see the following API Documentation:
+guide, see the following API documentation:
 
 - `find_one() <{+api+}/struct.Collection.html#method.find_one>`__
 - `find() <{+api+}/struct.Collection.html#method.find>`__
diff --git a/source/fundamentals/crud/write-operations/change.txt b/source/fundamentals/crud/write-operations/change.txt
@@ -338,8 +338,16 @@ Modify Update and Replace Behavior
 
 You can modify the behavior of the ``update_one()``, ``update_many``,
 and ``replace_one()`` methods by constructing and passing an
-``UpdateOptions`` struct as a parameter. The following table describes
-the options available in ``UpdateOptions``:
+``UpdateOptions`` struct as a parameter. 
+
+.. note:: Instantiating Options
+   
+   The {+driver-short+} implements the Builder design pattern for the
+   creation of many different types, including ``UpdateOptions``. You
+   can use each type's ``builder()`` method to construct an options
+   instance by chaining option builder functions one at a time.
+
+The following table describes the options available in ``UpdateOptions``:
 
 .. list-table::
    :header-rows: 1
@@ -441,7 +449,7 @@ API Documentation
 ~~~~~~~~~~~~~~~~~
 
 To learn more about any of the methods or types discussed in this
-guide, see the following API Documentation:
+guide, see the following API documentation:
 
 - `update_one() <{+api+}/struct.Collection.html#method.update_one>`__
 - `update_many() <{+api+}/struct.Collection.html#method.update_many>`__
diff --git a/source/fundamentals/crud/write-operations/delete.txt b/source/fundamentals/crud/write-operations/delete.txt
@@ -64,6 +64,13 @@ either method. You can specify settings in a ``DeleteOptions`` instance
 to configure the delete operation. To use default values for each
 setting, specify the value ``None`` as the options parameter.
 
+.. note:: Instantiating Options
+   
+   The {+driver-short+} implements the Builder design pattern for the
+   creation of many different types, including ``DeleteOptions``. You
+   can use each type's ``builder()`` method to construct an options
+   instance by chaining option builder functions one at a time.
+
 The following table describes settings that you can specify in a
 ``DeleteOptions`` instance:
 
@@ -181,7 +188,7 @@ API Documentation
 ~~~~~~~~~~~~~~~~~
 
 To learn more about any of the methods or types discussed in this
-guide, see the following API Documentation:
+guide, see the following API documentation:
 
 - `delete_one() <{+api+}/struct.Collection.html#method.delete_one>`__
 - `delete_many() <{+api+}/struct.Collection.html#method.delete_many>`__
diff --git a/source/fundamentals/crud/write-operations/insert.txt b/source/fundamentals/crud/write-operations/insert.txt
@@ -106,9 +106,16 @@ Modify insert_one Behavior
 ~~~~~~~~~~~~~~~~~~~~~~~~~~
 
 You can modify the behavior of the ``insert_one()`` method by
-constructing and passing an ``InsertOneOptions`` struct. The
-following table describes the options available in
-``InsertOneOptions``:
+constructing and passing an ``InsertOneOptions`` struct. 
+
+.. note:: Instantiating Options
+   
+   The {+driver-short+} implements the Builder design pattern for the
+   creation of many different types, including ``InsertOneOptions``.
+   You can use each type's ``builder()`` method to construct an options
+   instance by chaining option builder functions one at a time.
+
+The following table describes the options available in ``InsertOneOptions``:
 
 .. list-table::
    :header-rows: 1
@@ -312,7 +319,7 @@ API Documentation
 ~~~~~~~~~~~~~~~~~
 
 To learn more about any of the methods or types discussed in this
-guide, see the following API Documentation:
+guide, see the following API documentation:
 
 - `insert_one() <{+api+}/struct.Collection.html#method.insert_one>`__
 - `InsertOneResult <{+api+}/results/struct.InsertOneResult.html>`__
diff --git a/source/fundamentals/schema-validation.txt b/source/fundamentals/schema-validation.txt
@@ -58,6 +58,13 @@ in an instance of ``CreateCollectionOptions`` to the ``create_collection()``
 method. You can build a ``CreateCollectionOptions`` instance by using the
 ``CreateCollectionOptions::builder()`` method.
 
+.. note:: Instantiating Options
+   
+   The {+driver-short+} implements the Builder design pattern for the
+   creation of many different types, including ``CreateCollectionOptions``.
+   You can use each type's ``builder()`` method to construct an options
+   instance by chaining option builder functions one at a time.
+
 Call the following ``CreateCollectionOptions::builder()`` functions to specify
 the validation options for the new collection:
 
@@ -178,7 +185,7 @@ API Documentation
 ~~~~~~~~~~~~~~~~~
 
 To learn more about setting validation levels and actions, see the
-following API Documentation:
+following API documentation:
 
 - `validation_level <{+api+}/options/struct.CreateCollectionOptions.html#structfield.validation_level>`__ 
   for the ``validation_level()`` helper method
diff --git a/source/fundamentals/serialization.txt b/source/fundamentals/serialization.txt
@@ -301,7 +301,7 @@ their functionality:
   default value from ``Default::default()``
 
 For a full list of ``serde`` attributes, see the `serde Attributes
-API documentation <https://serde.rs/attributes.html>`__.
+API Documentation <https://serde.rs/attributes.html>`__.
 
 .. _rust-serialization-addtl-info:
 
@@ -323,7 +323,7 @@ API Documentation
 ~~~~~~~~~~~~~~~~~
 
 To learn more about the methods and types discussed in this
-guide, see the following API documentation:
+guide, see the following API Documentation:
 
 - `collection() <{+api+}/struct.Database.html#method.collection>`__
 - `clone_with_type() <{+api+}/struct.Collection.html#method.clone_with_type>`__
diff --git a/source/fundamentals/stable-api.txt b/source/fundamentals/stable-api.txt
@@ -69,9 +69,18 @@ and connects to a server.
 Modify Behavior
 ---------------
 
-You can modify the behavior of the {+stable-api+} feature by setting fields in the ``ServerApi`` struct.
+You can modify the behavior of the {+stable-api+} feature by setting fields
+in the ``ServerApi`` struct.
 
-While you can set the fields in a ``ServerApi`` struct manually, you can use the builder design pattern to define the struct more efficiently.
+While you can set the fields in a ``ServerApi`` struct manually, you can use
+the builder design pattern to define the struct more efficiently.
+
+.. note:: Instantiating Options
+   
+   The {+driver-short+} implements the Builder design pattern for the
+   creation of many different types, including the ``ServerApi`` struct.
+   You can use each type's ``builder()`` method to construct an options
+   instance by chaining option builder functions one at a time.
 
 .. list-table::
    :header-rows: 1
@@ -127,7 +136,7 @@ API Documentation
 ~~~~~~~~~~~~~~~~~
 
 To learn more about any of the methods or types discussed in this
-guide, see the following API Documentation:
+guide, see the following API documentation:
 
 - `Client <{+api+}/struct.Client.html>`__
 - `ClientOptions <{+api+}/options/struct.ClientOptions.html>`__
diff --git a/source/includes/fundamentals/code-snippets/crud/retrieve.rs b/source/includes/fundamentals/code-snippets/crud/retrieve.rs
@@ -34,9 +34,9 @@ async fn main() -> mongodb::error::Result<()> {
     ).await?;
 
     while let Some(result) = cursor.try_next().await? {
-        let doc = bson::from_document(result)?;
-        println!("{}", serde_json::to_string_pretty(&doc).unwrap());
-    }
+        println!("{}", result);
+    };
+    
     // end-find-many
     print!("\n");
 
@@ -48,7 +48,7 @@ async fn main() -> mongodb::error::Result<()> {
         opts
     ).await?;
 
-    println!("{}", serde_json::to_string_pretty(&result).unwrap());
+    println!("{:#?}", result);
     // end-find-one
     print!("\n");
 
@@ -61,9 +61,8 @@ async fn main() -> mongodb::error::Result<()> {
 
     let mut cursor = my_coll.aggregate(pipeline, None).await?;
     while let Some(result) = cursor.try_next().await? {
-        let doc = bson::from_document(result)?;
-        println!("{}", serde_json::to_string_pretty(&doc).unwrap());
-    }
+        println!("{}", result);
+    };
     // end-agg
 
     Ok(())
