Skip to content

Commit 0f8e244

Browse files
mongoKartgithub-actions[bot]
authored andcommitted
DOCSP-42966 - Remove nested components (#120)
(cherry picked from commit 8758706)
1 parent e33cad1 commit 0f8e244

File tree

6 files changed

+37
-66
lines changed

6 files changed

+37
-66
lines changed

source/includes/extracts-watch-option.yaml

Lines changed: 10 additions & 25 deletions
Original file line numberDiff line numberDiff line change
@@ -5,12 +5,10 @@ content: |
55
the maximum number of change events to return in each response from the
66
server.
77
8-
.. note::
9-
10-
Irrespective of the ``batchSize`` option, the initial ``aggregate`` command
11-
response for a change stream generally does not include any documents
12-
unless another option is used to configure its starting point (e.g.
13-
``startAfter``).
8+
Irrespective of the ``batchSize`` option, the initial ``aggregate`` command
9+
response for a change stream generally does not include any documents
10+
unless another option is used to configure its starting point (e.g.
11+
``startAfter``).
1412
---
1513
ref: watch-option-fullDocument
1614
content: |
@@ -37,9 +35,7 @@ content: |
3735
- ``MongoDB\Operation\Watch::FULL_DOCUMENT_WHEN_AVAILABLE``
3836
- ``MongoDB\Operation\Watch::FULL_DOCUMENT_REQUIRED``
3937
40-
.. note::
41-
42-
This is an option of the ``$changeStream`` pipeline stage.
38+
This is an option of the ``$changeStream`` pipeline stage.
4339
---
4440
ref: watch-option-fullDocumentBeforeChange
4541
content: |
@@ -57,9 +53,7 @@ content: |
5753
- ``MongoDB\Operation\Watch::FULL_DOCUMENT_BEFORE_CHANGE_WHEN_AVAILABLE``
5854
- ``MongoDB\Operation\Watch::FULL_DOCUMENT_BEFORE_CHANGE_REQUIRED``
5955
60-
.. note::
61-
62-
This is an option of the ``$changeStream`` pipeline stage.
56+
This is an option of the ``$changeStream`` pipeline stage.
6357
6458
.. versionadded:: 1.13
6559
---
@@ -77,9 +71,7 @@ content: |
7771
``startAtOperationTime`` will result in a server error. The options are
7872
mutually exclusive.
7973
80-
.. note::
81-
82-
This is an option of the ``$changeStream`` pipeline stage.
74+
This is an option of the ``$changeStream`` pipeline stage.
8375
---
8476
ref: watch-option-showExpandedEvents
8577
content: |
@@ -97,9 +89,7 @@ content: |
9789
This is not supported for server versions prior to 6.0 and will result in an
9890
exception at execution time if used.
9991
100-
.. note::
101-
102-
This is an option of the ``$changeStream`` pipeline stage.
92+
This is an option of the ``$changeStream`` pipeline stage.
10393
10494
.. versionadded:: 1.13
10595
---
@@ -117,9 +107,7 @@ content: |
117107
This is not supported for server versions prior to 4.2 and will result in an
118108
exception at execution time if used.
119109
120-
.. note::
121-
122-
This is an option of the ``$changeStream`` pipeline stage.
110+
This is an option of the ``$changeStream`` pipeline stage.
123111
124112
.. versionadded:: 1.5
125113
---
@@ -137,7 +125,4 @@ content: |
137125
This is not supported for server versions prior to 4.0 and will result in an
138126
exception at execution time if used.
139127
140-
.. note::
141-
142-
This is an option of the ``$changeStream`` pipeline stage.
143-
...
128+
This is an option of the ``$changeStream`` pipeline stage.

source/reference/method/MongoDBClient__construct.txt

Lines changed: 4 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -96,12 +96,10 @@ Parameters
9696
'platform' => 'some-platform',
9797
]
9898

99-
.. note::
100-
101-
This feature is primarily designed for custom drivers and ODMs,
102-
which may want to identify themselves to the server for diagnostic
103-
purposes. Applications wishing to identify themselves should use the
104-
``appName`` URI option instead of this option.
99+
This feature is primarily designed for custom drivers and ODMs,
100+
which may want to identify themselves to the server for diagnostic
101+
purposes. Applications wishing to identify themselves should use the
102+
``appName`` URI option instead of this option.
105103

106104
.. versionadded:: 1.7
107105

source/reference/method/MongoDBCollection-drop.txt

Lines changed: 4 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -54,12 +54,10 @@ Parameters
5454
`Field Encryption and Queryability <https://www.mongodb.com/docs/manual/core/queryable-encryption/fundamentals/encrypt-and-query/>`_
5555
in the MongoDB manual for more information.
5656

57-
.. note::
58-
59-
This option is not passed to the
60-
:manual:`drop </reference/command/drop>` command. The library uses
61-
it to determine related metadata collections that should be dropped
62-
in addition to an encrypted collection.
57+
This option is not passed to the
58+
:manual:`drop </reference/command/drop>` command. The library uses
59+
it to determine related metadata collections that should be dropped
60+
in addition to an encrypted collection.
6361

6462
.. versionadded:: 1.13
6563

source/reference/method/MongoDBCollection-mapReduce.txt

Lines changed: 2 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -92,10 +92,8 @@ Parameters
9292
- :php:`MongoDB\BSON\Javascript <class.mongodb-bson-javascript>`
9393
- Follows the reduce method and modifies the output.
9494

95-
.. note::
96-
97-
Passing a Javascript instance with a scope is deprecated. Put all
98-
scope variables in the ``scope`` option of the MapReduce operation.
95+
Passing a Javascript instance with a scope is deprecated. Put all
96+
scope variables in the ``scope`` option of the MapReduce operation.
9997

10098
* - jsMode
10199
- boolean

source/reference/method/MongoDBDatabase-createCollection.txt

Lines changed: 13 additions & 19 deletions
Original file line numberDiff line numberDiff line change
@@ -148,12 +148,10 @@ Parameters
148148

149149
Defaults to ``1``.
150150

151-
.. note::
152-
153-
MongoDB 3.0 and later ignores the ``usePowerOf2Sizes`` flag. See
154-
:manual:`collMod </reference/command/collMod>` and
155-
:manual:`db.createCollection()
156-
</reference/method/db.createCollection>` for more information.
151+
MongoDB 3.0 and later ignores the ``usePowerOf2Sizes`` flag. See
152+
:manual:`collMod </reference/command/collMod>` and
153+
:manual:`db.createCollection()
154+
</reference/method/db.createCollection>` for more information.
157155

158156
* - indexOptionDefaults
159157
- array|object
@@ -299,27 +297,23 @@ Parameters
299297
exception of :query:`$near`, :query:`$nearSphere`,
300298
:query:`$text`, and :query:`$where`.
301299

302-
.. note::
303-
304-
- Validation occurs during updates and inserts. Existing documents
305-
do not undergo validation checks until modification.
300+
Validation occurs during updates and inserts. Existing documents
301+
do not undergo validation checks until modification.
306302

307-
- You cannot specify a validator for collections in the ``admin``,
308-
``local``, and ``config`` databases.
303+
You cannot specify a validator for collections in the ``admin``,
304+
``local``, and ``config`` databases.
309305

310-
- You cannot specify a validator for ``system.*`` collections.
306+
You cannot specify a validator for ``system.*`` collections.
311307

312308
* - viewOn
313309
- string
314310
- The name of the source collection or view from which to create the view.
315311

316-
.. note::
312+
The name is not the full namespace of the collection or view (i.e.
313+
it does not include the database name). Views must be created in the
314+
same databases as the source collection or view.
317315

318-
The name is not the full namespace of the collection or view (i.e.
319-
it does not include the database name). Views must be created in the
320-
same databases as the source collection or view.
321-
322-
.. versionadded:: 1.13
316+
.. versionadded:: 1.13
323317

324318
* - writeConcern
325319
- :php:`MongoDB\Driver\WriteConcern <class.mongodb-driver-writeconcern>`

source/reference/method/MongoDBDatabase-dropCollection.txt

Lines changed: 4 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -60,12 +60,10 @@ Parameters
6060
`Field Encryption and Queryability <https://www.mongodb.com/docs/manual/core/queryable-encryption/fundamentals/encrypt-and-query/>`_
6161
in the MongoDB manual for more information.
6262

63-
.. note::
64-
65-
This option is not passed to the
66-
:manual:`drop </reference/command/drop>` command. The library uses
67-
it to determine related metadata collections that should be dropped
68-
in addition to an encrypted collection.
63+
This option is not passed to the
64+
:manual:`drop </reference/command/drop>` command. The library uses
65+
it to determine related metadata collections that should be dropped
66+
in addition to an encrypted collection.
6967

7068
.. versionadded:: 1.13
7169

0 commit comments

Comments
 (0)