Skip to content

DOCSP-37027: Fix 1.16 build errors (#1290) #1297

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 1 commit into from
May 10, 2024
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
21 changes: 10 additions & 11 deletions docs/includes/extracts-option-requires.yaml
Original file line number Diff line number Diff line change
@@ -1,48 +1,47 @@
ref: _option-requires-version
content: |
This option is available since MongoDB {{version}} and will result in an
exception at execution time if specified for an older server version.
---
ref: option-requires-4.2
source:
ref: option-requires-version
file: extracts-option-requires.yaml
ref: _option-requires-version
replacement:
version: "4.2"
---
ref: option-requires-4.4
source:
ref: option-requires-version
file: extracts-option-requires.yaml
ref: _option-requires-version
replacement:
version: "4.4"
---
ref: option-requires-5.0
source:
ref: option-requires-version
file: extracts-option-requires.yaml
ref: _option-requires-version
replacement:
version: "5.0"
---
ref: option-requires-5.3
source:
ref: option-requires-version
file: extracts-option-requires.yaml
ref: _option-requires-version
replacement:
version: "5.3"
---
ref: option-requires-6.0
source:
ref: option-requires-version
file: extracts-option-requires.yaml
ref: _option-requires-version
replacement:
version: "6.0"
---
ref: option-requires-7.0
source:
ref: option-requires-version
file: extracts-option-requires.yaml
ref: _option-requires-version
replacement:
version: "7.0"
---
ref: option-requires-version
content: |
This option is available since MongoDB {{version}} and will result in an
exception at execution time if specified for an older server version.
...
2 changes: 0 additions & 2 deletions docs/reference.txt
Original file line number Diff line number Diff line change
Expand Up @@ -12,8 +12,6 @@ Reference
/reference/class/MongoDBDatabase
/reference/class/MongoDBCollection
/reference/class/MongoDBGridFSBucket
/reference/write-result-classes
/reference/result-classes
/reference/enumeration-classes
/reference/functions
/reference/exception-classes
12 changes: 6 additions & 6 deletions docs/reference/method/MongoDBCollection-bulkWrite.txt
Original file line number Diff line number Diff line change
Expand Up @@ -30,12 +30,12 @@ Parameters
``$operations`` : array
An array containing the write operations to perform.
:phpmethod:`MongoDB\Collection::bulkWrite()` supports
:phpmethod:`deleteMany() <MongoDB\Collection::deleteMany>`,
:phpmethod:`deleteOne() <MongoDB\Collection::deleteOne>`,
:phpmethod:`insertOne() <MongoDB\Collection::insertOne>`,
:phpmethod:`replaceOne() <MongoDB\Collection::replaceOne>`,
:phpmethod:`updateMany() <MongoDB\Collection::updateMany>`, and
:phpmethod:`updateOne() <MongoDB\Collection::updateOne>` operations in the
:phpmethod:`MongoDB\Collection::deleteMany()`,
:phpmethod:`MongoDB\Collection::deleteOne()`,
:phpmethod:`MongoDB\Collection::insertOne()`,
:phpmethod:`MongoDB\Collection::replaceOne()`,
:phpmethod:`MongoDB\Collection::updateMany()`, and
:phpmethod:`MongoDB\Collection::updateOne()` operations in the
following array structure:

.. code-block:: php
Expand Down
3 changes: 1 addition & 2 deletions docs/reference/method/MongoDBCollection-dropIndex.txt
Original file line number Diff line number Diff line change
Expand Up @@ -29,8 +29,7 @@ Parameters

``$indexName`` : string| :phpclass:`MongoDB\Model\IndexInfo`
The name or model object of the index to drop. View the existing indexes on
the collection using the :phpmethod:`listIndexes()
<MongoDB\Collection::listIndexes>` method.
the collection by using the :phpmethod:`MongoDB\Collection::listIndexes()` method.

``$options`` : array
An array specifying the desired options.
Expand Down
2 changes: 1 addition & 1 deletion docs/reference/method/MongoDBCollection-dropIndexes.txt
Original file line number Diff line number Diff line change
Expand Up @@ -28,7 +28,7 @@ Parameters
``$indexName`` : string| :phpclass:`MongoDB\Model\IndexInfo`
The name or model object of the index to drop. View the existing indexes on
the collection using the :phpmethod:`listIndexes()
<MongoDB\Collection::listIndexes>` method.
<MongoDB\Collection::listIndexes()>` method.

``$options`` : array
An array specifying the desired options.
Expand Down
2 changes: 1 addition & 1 deletion docs/reference/method/MongoDBCollection-explain.txt
Original file line number Diff line number Diff line change
Expand Up @@ -29,7 +29,7 @@ Definition
Parameters
----------

``$explainable`` : :phpclass:`MongoDB\Operation\Explainable`
``$explainable`` : ``MongoDB\Operation\Explainable``
The command to explain.

``$options`` : array
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -33,7 +33,7 @@ Parameters

``$update`` : array|object
Specifies the field and value combinations to update and any relevant update
operators. ``$update`` uses MongoDB's :method:`update operators
operators. ``$update`` uses MongoDB's :manual:`update operators
</reference/operator/update>`. Starting with MongoDB 4.2, an `aggregation
pipeline <https://mongodb.com/docs/master/reference/command/update/#update-with-an-aggregation-pipeline>`_
can be passed as this parameter.
Expand Down
2 changes: 1 addition & 1 deletion docs/reference/method/MongoDBCollection-updateMany.txt
Original file line number Diff line number Diff line change
Expand Up @@ -33,7 +33,7 @@ Parameters

``$update`` : array|object
Specifies the field and value combinations to update and any relevant update
operators. ``$update`` uses MongoDB's :method:`update operators
operators. ``$update`` uses MongoDB's :manual:`update operators
</reference/operator/update>`. Starting with MongoDB 4.2, an `aggregation
pipeline <https://mongodb.com/docs/master/reference/command/update/#update-with-an-aggregation-pipeline>`_
can be passed as this parameter.
Expand Down
2 changes: 1 addition & 1 deletion docs/reference/method/MongoDBCollection-updateOne.txt
Original file line number Diff line number Diff line change
Expand Up @@ -35,7 +35,7 @@ Parameters

``$update`` : array|object
Specifies the field and value combinations to update and any relevant update
operators. ``$update`` uses MongoDB's :method:`update operators
operators. ``$update`` uses MongoDB's :manual:`update operators
</reference/operator/update>`. Starting with MongoDB 4.2, an `aggregation
pipeline <https://mongodb.com/docs/master/reference/command/update/#update-with-an-aggregation-pipeline>`_
can be passed as this parameter.
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -296,7 +296,7 @@ Parameters
rules or expressions. You can specify the expressions using the same
operators as MongoDB's
:manual:`query operators </reference/operator/query>` with the
exception of :query:`$geoNear`, :query:`$near`, :query:`$nearSphere`,
exception of :query:`$near`, :query:`$nearSphere`,
:query:`$text`, and :query:`$where`.

.. note::
Expand Down
2 changes: 1 addition & 1 deletion docs/reference/result-classes.txt
Original file line number Diff line number Diff line change
Expand Up @@ -10,7 +10,7 @@ Result Classes
BulkWriteResult Class </reference/class/MongoDBBulkWriteResult>
DeleteResult Class </reference/class/MongoDBDeleteResult>
InsertManyResult Class </reference/class/MongoDBInsertManyResult>
InsertOneResult Class </reference/class/MongoDInsertOneResult>
InsertOneResult Class </reference/class/MongoDBInsertOneResult>
UpdateResult Class </reference/class/MongoDBUpdateResult>
ChangeStream Class </reference/class/MongoDBChangeStream>
MapReduceResult Class </reference/class/MongoDBMapReduceResult>
Expand Down
2 changes: 1 addition & 1 deletion docs/tutorial/gridfs.txt
Original file line number Diff line number Diff line change
Expand Up @@ -35,7 +35,7 @@ The bucket can be constructed with various options:
needed. The default size is ``261120`` (i.e. 255 KiB).
- ``readConcern``, ``readPreference`` and ``writeConcern`` options can be used
to specify defaults for read and write operations, much like the
:phpclass:`MongoDB\GridFS\Collection` options.
:phpclass:`MongoDB\Collection` options.

Uploading Files with Writable Streams
-------------------------------------
Expand Down
Loading