NR PR fixes 1

rustagir · rustagir · commit f25264d1cf35 · 2025-05-21T15:45:30.000-04:00
diff --git a/source/includes/extracts-bulkwriteexception.yaml b/source/includes/extracts-bulkwriteexception.yaml
@@ -1,7 +1,7 @@
 ref: bulkwriteexception-result
 content: |
   If a :php:`MongoDB\Driver\Exception\BulkWriteException
-  <mongodb-driver-exception-bulkwriteexception>` is thrown, users should call
+  <mongodb-driver-exception-bulkwriteexception>` is thrown, you can call
   :php:`getWriteResult() <mongodb-driver-bulkwriteexception.getwriteresult>` and
   inspect the returned :php:`MongoDB\Driver\WriteResult
   <mongodb-driver-writeresult>` object to determine the nature of the error.
@@ -14,7 +14,7 @@ content: |
 ref: bulkwriteexception-client-result
 content: |
   If a :php:`MongoDB\Driver\Exception\BulkWriteCommandException
-  <mongodb-driver-exception-bulkwritecommandexception>` is thrown, users should call
+  <mongodb-driver-exception-bulkwritecommandexception>` is thrown, you can call
   :php:`getWriteErrors() <mongodb-driver-bulkwritecommandexception.getwriteerrors>` and
   inspect the information in the returned array to determine the nature of the error.
 
@@ -25,7 +25,7 @@ content: |
 ---
 ref: bulkwriteexception-ordered
 content: |
-  In the case of a bulk write, the result may indicate multiple successful write
+  In the case of a bulk write, the result might indicate multiple successful write
   operations and/or errors. If the ``ordered`` option is ``true``, some
   operations may have succeeded before the first error was encountered and the
   exception thrown. If the ``ordered`` option is ``false``, multiple errors may
diff --git a/source/includes/extracts-error.yaml b/source/includes/extracts-error.yaml
@@ -2,15 +2,15 @@ ref: error-driver-bulkwriteexception
 content: |
   :php:`MongoDB\Driver\Exception\BulkWriteException
   <mongodb-driver-exception-bulkwriteexception>` for errors related to the write
-  operation. Users should inspect the value returned by :php:`getWriteResult()
+  operation. You can inspect the value returned by :php:`getWriteResult()
   <mongodb-driver-bulkwriteexception.getwriteresult>` to determine the nature of the
   error.
 ---
 ref: error-driver-client-bulkwriteexception
 content: |
   :php:`MongoDB\Driver\Exception\BulkWriteCommandException
   <mongodb-driver-exception-bulkwritecommandexception>` for errors related to the write
-  operation. Users should inspect the value returned by :php:`getWriteErrors()
+  operation. You can inspect the value returned by :php:`getWriteErrors()
   <mongodb-driver-bulkwritecommandexception.getwriteerrors>` to determine the nature of the
   error.
 ---
diff --git a/source/includes/write/bulk-write.php b/source/includes/write/bulk-write.php
@@ -117,31 +117,48 @@
 // start-bulk-client
 $restaurantCollection = $client->sample_restaurants->restaurants;
 $movieCollection = $client->sample_mflix->movies;
-
+// Creates the bulk write command and sets the target namespace.
 $bulkWrite = MongoDB\ClientBulkWrite::createWithCollection($restaurantCollection);
+// Specifies insertion of one document.
 $bulkWrite->insertOne(['name' => 'Mongo Deli', 'cuisine' => 'Sandwiches']);
+// Specifies a `$set` update to one document with the upsert option
+// enabled.
 $bulkWrite->updateOne(
     ['name' => 'Dandelion Bakery'],
     ['$set' => ['grade' => 'B+']],
     ['upsert' => true],
 );
-
+// Changes the target namespace.
 $bulkWrite = $bulkWrite->withCollection($movieCollection);
+// Specifies insertion of one document.
 $bulkWrite->insertOne(['title' => 'The Green Ray', 'year' => 1986]);
+// Specifies deletion of documents in which `title` has two consective
+// 'd' characters.
 $bulkWrite->deleteMany(
     ['title' => ['$regex' => 'd{2,}']],
 );
+// Specifies replacement of one document.
 $bulkWrite->replaceOne(
     ['runtime' => ['$gte' => 200]],
     ['title' => 'Seven Samurai', 'runtime' => 203],
 );
 
+// Performs the bulk write operation.
 $result = $client->bulkWrite($bulkWrite);
+// Prints a summary of results.
 echo 'Inserted documents: ', $result->getInsertedCount(), PHP_EOL;
 echo 'Modified documents: ', $result->getModifiedCount(), PHP_EOL;
 echo 'Deleted documents: ', $result->getDeletedCount(), PHP_EOL;
 // end-bulk-client
 
 // start-bulk-client-options
-$bulkWrite = MongoDB\ClientBulkWrite::createWithCollection($collection, ['ordered' => false]);
+$bulkWrite = MongoDB\ClientBulkWrite::createWithCollection(
+    $restaurantCollection,
+    ['ordered' => false]
+);
 // end-bulk-client-options
+
+// start-bulk-client-unordered-behavior
+$bulkWrite->insertOne(['_id' => 4045, 'title' => 'The Green Ray']);
+$bulkWrite->deleteOne(['_id' => 4045]);
+// end-bulk-client-unordered-behavior
diff --git a/source/reference/class/MongoDBBulkWriteCommandResult.txt b/source/reference/class/MongoDBBulkWriteCommandResult.txt
@@ -7,7 +7,7 @@ Definition
 
 .. phpclass:: MongoDB\BulkWriteCommandResult
 
-   This class contains information about an executed client bulk write operation. It
+   This class contains information about a completed client bulk write operation. It
    is returned from :phpmethod:`MongoDB\Client::bulkWrite()`.
 
 Methods
@@ -57,8 +57,8 @@ Methods
          a document with information corresponding to the operation.
 
    * - ``isAcknowledged()``
-     - | Returns a boolean indicating whether the bulk operation was
-         acknowledged by the server.
+     - | Returns a boolean indicating whether the server acknowledged
+         the bulk operation.
 
 To learn more about the information returned from the server when you
 perform a client bulk write operation, see the :manual:`Output
diff --git a/source/reference/class/MongoDBBulkWriteResult.txt b/source/reference/class/MongoDBBulkWriteResult.txt
@@ -7,7 +7,7 @@ Definition
 
 .. phpclass:: MongoDB\BulkWriteResult
 
-   This class contains information about an executed bulk write operation. It
+   This class contains information about a completed bulk write operation. It
    encapsulates a :php:`MongoDB\Driver\WriteResult <class.mongodb-driver-writeresult>`
    object and is returned from :phpmethod:`MongoDB\Collection::bulkWrite()`.
 
@@ -33,4 +33,4 @@ Methods
 - :phpmethod:`MongoDB\BulkWriteResult::getModifiedCount()`
 - :phpmethod:`MongoDB\BulkWriteResult::getUpsertedCount()`
 - :phpmethod:`MongoDB\BulkWriteResult::getUpsertedIds()`
-- :phpmethod:`MongoDB\BulkWriteResult::isAcknowledged()`
+- :phpmethod:`MongoDB\BulkWriteResult::isAcknowledged()`
diff --git a/source/reference/method/MongoDBClient-bulkWrite.txt b/source/reference/method/MongoDBClient-bulkWrite.txt
@@ -43,7 +43,7 @@ Parameters
 
   Represents the assembled bulk write command or builder.
   :phpmethod:`MongoDB\Client::bulkWrite()` supports
-  ``deleteMany``, ``deleteOne()``, ``insertOne()``,
+  ``deleteMany()``, ``deleteOne()``, ``insertOne()``,
   ``replaceOne()``, ``updateMany()``, and ``updateOne()``
   operations.
 
diff --git a/source/reference/method/MongoDBClientBulkWrite-createWithCollection.txt b/source/reference/method/MongoDBClientBulkWrite-createWithCollection.txt
@@ -48,8 +48,10 @@ Parameters
 
      * - bypassDocumentValidation
        - boolean
-       - If ``true``, allows the write operation to circumvent document level
-         validation. Defaults to ``false``.
+       - If ``true``: the write operation ignores document level
+         validation.
+         
+         The default is ``false``.
 
      * - comment
        - mixed
@@ -61,17 +63,19 @@ Parameters
 
      * - ordered
        - boolean
-       - If ``true``: when a single write fails, the operation stops without
-         performing the remaining writes and throws an exception.
+       - If ``true``: When a single write fails, the operation stops without
+         performing the remaining writes and returns an exception.
 
-         If ``false``: when a single write fails, the operation continues
-         with the remaining writes, if any, and throws an exception.
+         If ``false``: When a single write fails, the operation continues
+         with the remaining writes, if any, and returns an exception.
 
          The default is ``true``.
 
      * - verboseResults
        - boolean
-       - Specifies whether to return verbose results. The default is ``false``.
+       - Specifies whether to return verbose results.
+         
+         The default is ``false``.
 
 Return Values
 -------------
diff --git a/source/reference/method/MongoDBClientBulkWrite-deleteMany.txt b/source/reference/method/MongoDBClientBulkWrite-deleteMany.txt
@@ -17,7 +17,7 @@ Definition
 
    Specify a delete operation in the bulk write command for all
    matching documents. This method returns the
-   :phpclass:`MongoDB\ClientBulkWrite` instance on which its called.
+   :phpclass:`MongoDB\ClientBulkWrite` instance on which it's called.
 
    .. code-block:: php
 
diff --git a/source/reference/method/MongoDBClientBulkWrite-deleteOne.txt b/source/reference/method/MongoDBClientBulkWrite-deleteOne.txt
@@ -17,7 +17,7 @@ Definition
 
    Specify a delete operation in the bulk write command for the first
    matching document. This method returns the
-   :phpclass:`MongoDB\ClientBulkWrite` instance on which its called.
+   :phpclass:`MongoDB\ClientBulkWrite` instance on which it's called.
 
    .. code-block:: php
 
diff --git a/source/reference/method/MongoDBClientBulkWrite-insertOne.txt b/source/reference/method/MongoDBClientBulkWrite-insertOne.txt
@@ -16,7 +16,7 @@ Definition
 .. phpmethod:: MongoDB\ClientBulkWrite::insertOne()
  
    Specify an insert operation in the bulk write command. This method
-   returns the :phpclass:`MongoDB\ClientBulkWrite` instance on which its called.
+   returns the :phpclass:`MongoDB\ClientBulkWrite` instance on which it's called.
 
    .. code-block:: php
 
diff --git a/source/reference/method/MongoDBClientBulkWrite-replaceOne.txt b/source/reference/method/MongoDBClientBulkWrite-replaceOne.txt
@@ -17,7 +17,7 @@ Definition
 
    Specify a replace operation in the bulk write command for the first
    matching document. This method returns the
-   :phpclass:`MongoDB\ClientBulkWrite` instance on which its called.
+   :phpclass:`MongoDB\ClientBulkWrite` instance on which it's called.
 
    .. code-block:: php
 
diff --git a/source/reference/method/MongoDBClientBulkWrite-updateMany.txt b/source/reference/method/MongoDBClientBulkWrite-updateMany.txt
@@ -17,7 +17,7 @@ Definition
 
    Specify an update operation in the bulk write command for all
    matching documents. This method returns the
-   :phpclass:`MongoDB\ClientBulkWrite` instance on which its called.
+   :phpclass:`MongoDB\ClientBulkWrite` instance on which it's called.
 
    .. code-block:: php
 
@@ -34,7 +34,7 @@ Parameters
   The filter criteria that specifies the documents to update.
 
 ``$update`` : array|object
-  Specifies the field and value combinations to update and any relevant update
+  The field and value combinations to update and any relevant update
   operators. ``$update`` uses MongoDB's :manual:`update operators </reference/operator/update>`.
   You can pass an :manual:`aggregation pipeline
   </reference/command/update/#update-with-an-aggregation-pipeline>` as this parameter. 
diff --git a/source/reference/method/MongoDBClientBulkWrite-updateOne.txt b/source/reference/method/MongoDBClientBulkWrite-updateOne.txt
@@ -17,7 +17,7 @@ Definition
 
    Specify an update operation in the bulk write command for the first
    matching document. This method returns the
-   :phpclass:`MongoDB\ClientBulkWrite` instance on which its called.
+   :phpclass:`MongoDB\ClientBulkWrite` instance on which it's called.
 
    .. code-block:: php
 
@@ -34,7 +34,7 @@ Parameters
   The filter criteria that specifies the documents to update.
 
 ``$update`` : array|object
-  Specifies the field and value combinations to update and any relevant update
+  The field and value combinations to update and any relevant update
   operators. ``$update`` uses MongoDB's :manual:`update operators
   </reference/operator/update>`. You can pass an :manual:`aggregation pipeline
   </reference/command/update/#update-with-an-aggregation-pipeline>` as
diff --git a/source/reference/method/MongoDBClientBulkWrite-withCollection.txt b/source/reference/method/MongoDBClientBulkWrite-withCollection.txt
@@ -18,8 +18,7 @@ Definition
    Return an updated instance of :phpclass:`MongoDB\ClientBulkWrite`
    from the provided :phpclass:`MongoDB\Collection` instance. This
    method allows you to add subsequent write operations on a different
-   collection than that with which the ``ClientBulkWrite`` was created
-   with.
+   collection than that with which the ``ClientBulkWrite`` was created.
 
    This method does not build a new :php:`BulkWriteCommand
    <mongodb-driver-bulkwritecommand>` and does not edit the
diff --git a/source/reference/method/MongoDBCollection-bulkWrite.txt b/source/reference/method/MongoDBCollection-bulkWrite.txt
@@ -104,10 +104,10 @@ Parameters
 
      * - ordered
        - boolean
-       - If ``true``: when a single write fails, the operation will stop without
+       - If ``true``: When a single write fails, the operation will stop without
          performing the remaining writes and throw an exception.
 
-         If ``false``: when a single write fails, the operation will continue
+         If ``false``: When a single write fails, the operation will continue
          with the remaining writes, if any, and throw an exception.
 
          The default is ``true``.
diff --git a/source/reference/method/MongoDBCollection-insertMany.txt b/source/reference/method/MongoDBCollection-insertMany.txt
@@ -64,10 +64,10 @@ Parameters
 
      * - ordered
        - boolean
-       - If ``true``: when a single write fails, the operation will stop without
+       - If ``true``: When a single write fails, the operation will stop without
          performing the remaining writes and throw an exception.
 
-         If ``false``: when a single write fails, the operation will continue
+         If ``false``: When a single write fails, the operation will continue
          with the remaining writes, if any, and throw an exception.
 
          The default is ``true``.
diff --git a/source/write/bulk-write.txt b/source/write/bulk-write.txt
diff --git a/source/write/replace.txt b/source/write/replace.txt
diff --git a/source/write/update.txt b/source/write/update.txt
