From 3738550ff2cdbe2136b0a253f70eedbedce65aac Mon Sep 17 00:00:00 2001 From: Mike Woofter <108414937+mongoKart@users.noreply.github.com> Date: Fri, 30 Aug 2024 11:12:17 -0500 Subject: [PATCH 1/2] remove nested admonitions --- source/includes/extracts-watch-option.yaml | 35 ++++++------------- .../method/MongoDBClient__construct.txt | 10 +++--- 2 files changed, 14 insertions(+), 31 deletions(-) diff --git a/source/includes/extracts-watch-option.yaml b/source/includes/extracts-watch-option.yaml index 648989c7..4974d57c 100644 --- a/source/includes/extracts-watch-option.yaml +++ b/source/includes/extracts-watch-option.yaml @@ -5,12 +5,10 @@ content: | the maximum number of change events to return in each response from the server. - .. note:: - - Irrespective of the ``batchSize`` option, the initial ``aggregate`` command - response for a change stream generally does not include any documents - unless another option is used to configure its starting point (e.g. - ``startAfter``). + Irrespective of the ``batchSize`` option, the initial ``aggregate`` command + response for a change stream generally does not include any documents + unless another option is used to configure its starting point (e.g. + ``startAfter``). --- ref: watch-option-fullDocument content: | @@ -37,9 +35,7 @@ content: | - ``MongoDB\Operation\Watch::FULL_DOCUMENT_WHEN_AVAILABLE`` - ``MongoDB\Operation\Watch::FULL_DOCUMENT_REQUIRED`` - .. note:: - - This is an option of the ``$changeStream`` pipeline stage. + This is an option of the ``$changeStream`` pipeline stage. --- ref: watch-option-fullDocumentBeforeChange content: | @@ -57,9 +53,7 @@ content: | - ``MongoDB\Operation\Watch::FULL_DOCUMENT_BEFORE_CHANGE_WHEN_AVAILABLE`` - ``MongoDB\Operation\Watch::FULL_DOCUMENT_BEFORE_CHANGE_REQUIRED`` - .. note:: - - This is an option of the ``$changeStream`` pipeline stage. + This is an option of the ``$changeStream`` pipeline stage. .. versionadded:: 1.13 --- @@ -77,9 +71,7 @@ content: | ``startAtOperationTime`` will result in a server error. The options are mutually exclusive. - .. note:: - - This is an option of the ``$changeStream`` pipeline stage. + This is an option of the ``$changeStream`` pipeline stage. --- ref: watch-option-showExpandedEvents content: | @@ -97,9 +89,7 @@ content: | This is not supported for server versions prior to 6.0 and will result in an exception at execution time if used. - .. note:: - - This is an option of the ``$changeStream`` pipeline stage. + This is an option of the ``$changeStream`` pipeline stage. .. versionadded:: 1.13 --- @@ -117,9 +107,7 @@ content: | This is not supported for server versions prior to 4.2 and will result in an exception at execution time if used. - .. note:: - - This is an option of the ``$changeStream`` pipeline stage. + This is an option of the ``$changeStream`` pipeline stage. .. versionadded:: 1.5 --- @@ -137,7 +125,4 @@ content: | This is not supported for server versions prior to 4.0 and will result in an exception at execution time if used. - .. note:: - - This is an option of the ``$changeStream`` pipeline stage. -... + This is an option of the ``$changeStream`` pipeline stage. diff --git a/source/reference/method/MongoDBClient__construct.txt b/source/reference/method/MongoDBClient__construct.txt index 79e5daa8..3d8ad586 100644 --- a/source/reference/method/MongoDBClient__construct.txt +++ b/source/reference/method/MongoDBClient__construct.txt @@ -96,12 +96,10 @@ Parameters 'platform' => 'some-platform', ] - .. note:: - - This feature is primarily designed for custom drivers and ODMs, - which may want to identify themselves to the server for diagnostic - purposes. Applications wishing to identify themselves should use the - ``appName`` URI option instead of this option. + This feature is primarily designed for custom drivers and ODMs, + which may want to identify themselves to the server for diagnostic + purposes. Applications wishing to identify themselves should use the + ``appName`` URI option instead of this option. .. versionadded:: 1.7 From 0f43a0c28e6db65f9a71cf665927b7483c24eda8 Mon Sep 17 00:00:00 2001 From: Mike Woofter <108414937+mongoKart@users.noreply.github.com> Date: Fri, 30 Aug 2024 11:31:25 -0500 Subject: [PATCH 2/2] remove admonitions --- .../method/MongoDBCollection-drop.txt | 10 +++--- .../method/MongoDBCollection-mapReduce.txt | 6 ++-- .../MongoDBDatabase-createCollection.txt | 32 ++++++++----------- .../method/MongoDBDatabase-dropCollection.txt | 10 +++--- 4 files changed, 23 insertions(+), 35 deletions(-) diff --git a/source/reference/method/MongoDBCollection-drop.txt b/source/reference/method/MongoDBCollection-drop.txt index 93b6a17c..e220e076 100644 --- a/source/reference/method/MongoDBCollection-drop.txt +++ b/source/reference/method/MongoDBCollection-drop.txt @@ -54,12 +54,10 @@ Parameters `Field Encryption and Queryability `_ in the MongoDB manual for more information. - .. note:: - - This option is not passed to the - :manual:`drop ` command. The library uses - it to determine related metadata collections that should be dropped - in addition to an encrypted collection. + This option is not passed to the + :manual:`drop ` command. The library uses + it to determine related metadata collections that should be dropped + in addition to an encrypted collection. .. versionadded:: 1.13 diff --git a/source/reference/method/MongoDBCollection-mapReduce.txt b/source/reference/method/MongoDBCollection-mapReduce.txt index afb57373..6f57fdf6 100644 --- a/source/reference/method/MongoDBCollection-mapReduce.txt +++ b/source/reference/method/MongoDBCollection-mapReduce.txt @@ -92,10 +92,8 @@ Parameters - :php:`MongoDB\BSON\Javascript ` - Follows the reduce method and modifies the output. - .. note:: - - Passing a Javascript instance with a scope is deprecated. Put all - scope variables in the ``scope`` option of the MapReduce operation. + Passing a Javascript instance with a scope is deprecated. Put all + scope variables in the ``scope`` option of the MapReduce operation. * - jsMode - boolean diff --git a/source/reference/method/MongoDBDatabase-createCollection.txt b/source/reference/method/MongoDBDatabase-createCollection.txt index 8b49e901..23c4e51f 100644 --- a/source/reference/method/MongoDBDatabase-createCollection.txt +++ b/source/reference/method/MongoDBDatabase-createCollection.txt @@ -148,12 +148,10 @@ Parameters Defaults to ``1``. - .. note:: - - MongoDB 3.0 and later ignores the ``usePowerOf2Sizes`` flag. See - :manual:`collMod ` and - :manual:`db.createCollection() - ` for more information. + MongoDB 3.0 and later ignores the ``usePowerOf2Sizes`` flag. See + :manual:`collMod ` and + :manual:`db.createCollection() + ` for more information. * - indexOptionDefaults - array|object @@ -299,27 +297,23 @@ Parameters exception of :query:`$near`, :query:`$nearSphere`, :query:`$text`, and :query:`$where`. - .. note:: - - - Validation occurs during updates and inserts. Existing documents - do not undergo validation checks until modification. + Validation occurs during updates and inserts. Existing documents + do not undergo validation checks until modification. - - You cannot specify a validator for collections in the ``admin``, - ``local``, and ``config`` databases. + You cannot specify a validator for collections in the ``admin``, + ``local``, and ``config`` databases. - - You cannot specify a validator for ``system.*`` collections. + You cannot specify a validator for ``system.*`` collections. * - viewOn - string - The name of the source collection or view from which to create the view. - .. note:: + The name is not the full namespace of the collection or view (i.e. + it does not include the database name). Views must be created in the + same databases as the source collection or view. - The name is not the full namespace of the collection or view (i.e. - it does not include the database name). Views must be created in the - same databases as the source collection or view. - - .. versionadded:: 1.13 + .. versionadded:: 1.13 * - writeConcern - :php:`MongoDB\Driver\WriteConcern ` diff --git a/source/reference/method/MongoDBDatabase-dropCollection.txt b/source/reference/method/MongoDBDatabase-dropCollection.txt index 71beda83..5ecc8def 100644 --- a/source/reference/method/MongoDBDatabase-dropCollection.txt +++ b/source/reference/method/MongoDBDatabase-dropCollection.txt @@ -60,12 +60,10 @@ Parameters `Field Encryption and Queryability `_ in the MongoDB manual for more information. - .. note:: - - This option is not passed to the - :manual:`drop ` command. The library uses - it to determine related metadata collections that should be dropped - in addition to an encrypted collection. + This option is not passed to the + :manual:`drop ` command. The library uses + it to determine related metadata collections that should be dropped + in addition to an encrypted collection. .. versionadded:: 1.13