Skip to content

Commit ed8e772

Browse files
authored
DOCSP-35757 Fix :phpmethod: Build Errors (#5955)
* Empty-Commit * <phpmethod.MongoDB\Collection::find() * " * * * * * * * * * * * deleteMany() * * * * * * * updateOne() * updateMany() * insertMany() * * * deleteMany() * getInsertedId() one and many * * * * * createIndex() * getDeletedCount()
1 parent d9cffc4 commit ed8e772

10 files changed

+40
-40
lines changed

snooty.toml

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -5,7 +5,7 @@ intersphinx = [
55
"https://pymongo.readthedocs.io/en/stable/objects.inv",
66
"https://motor.readthedocs.io/en/stable/objects.inv",
77
"https://www.mongodb.com/docs/atlas/objects.inv",
8-
"https://www.mongodb.com/docs/php-library/current/objects.inv",
8+
"https://www.mongodb.com/docs/php-library/upcoming/objects.inv",
99
"https://www.mongodb.com/docs/compass/current/objects.inv",
1010
"https://www.mongodb.com/docs/database-tools/objects.inv",
1111
"https://www.mongodb.com/docs/mongodb-shell/objects.inv",

source/includes/driver-examples/driver-example-delete-result.rst

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -47,10 +47,10 @@
4747
- id: php
4848
content: |
4949
Upon successful execution, the
50-
:phpmethod:`deleteMany() <phpmethod.MongoDB\\Collection::deleteMany>`
50+
:phpmethod:`deleteMany() <phpmethod.MongoDB\\Collection::deleteMany()>`
5151
method returns an instance of
5252
:phpclass:`MongoDB\\DeleteResult <phpclass.MongoDB\\DeleteResult>`
53-
whose :phpmethod:`getDeletedCount()<phpmethod.MongoDB\\DeleteResult::getDeletedCount>`
53+
whose :phpmethod:`getDeletedCount()<phpmethod.MongoDB\\DeleteResult::getDeletedCount()>`
5454
method returns the number of documents that matched the filter.
5555

5656
- id: perl

source/includes/driver-examples/driver-example-query-intro-no-perl.rst

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -75,7 +75,7 @@
7575
content: |
7676

7777
This page provides examples of |query_operations| using the
78-
:phpmethod:`MongoDB\\Collection::find() <phpmethod.MongoDB\\Collection::find>`
78+
:phpmethod:`MongoDB\\Collection::find() <phpmethod.MongoDB\\Collection::find()>`
7979
method in the
8080
`MongoDB PHP Library <https://www.mongodb.com/docs/drivers/php-libraries/>`_.
8181

source/includes/driver-examples/driver-example-query-intro.rst

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -67,7 +67,7 @@
6767
- id: php
6868
content: |
6969
This page provides examples of |query_operations| using the
70-
:phpmethod:`MongoDB\\Collection::find() <phpmethod.MongoDB\\Collection::find>`
70+
:phpmethod:`MongoDB\\Collection::find() <phpmethod.MongoDB\\Collection::find()>`
7171
method in the
7272
`MongoDB PHP Library <https://www.mongodb.com/docs/drivers/php-libraries/>`_.
7373

source/includes/driver-examples/driver-procedure-indexes-1.rst

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -77,7 +77,7 @@
7777
7878
To create an index using the
7979
`PHP driver <https://www.mongodb.com/docs/php-library/current/>`_, use
80-
:phpmethod:`MongoDB\\Collection::createIndex() <phpmethod.MongoDB\\Collection::createIndex>`.
80+
:phpmethod:`MongoDB\\Collection::createIndex() <phpmethod.MongoDB\\Collection::createIndex()>`.
8181
8282
.. code-block:: php
8383

source/tutorial/insert-documents.txt

Lines changed: 8 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -210,7 +210,7 @@ Insert a Single Document
210210
.. tab::
211211
:tabid: php
212212

213-
:phpmethod:`MongoDB\\Collection::insertOne() <phpmethod.MongoDB\\Collection::insertOne>`
213+
:phpmethod:`MongoDB\\Collection::insertOne() <phpmethod.MongoDB\\Collection::insertOne()>`
214214
inserts a *single* :ref:`document<bson-document-format>` into a
215215
collection.
216216

@@ -346,11 +346,11 @@ Insert a Single Document
346346
:tabid: php
347347

348348
Upon successful insert, the
349-
:phpmethod:`insertOne() <phpmethod.MongoDB\\Collection::insertOne>`
349+
:phpmethod:`insertOne() <phpmethod.MongoDB\\Collection::insertOne()>`
350350
method returns an instance of
351351
:phpclass:`MongoDB\\InsertOneResult <phpclass.MongoDB\\InsertOneResult>`
352352
whose
353-
:phpmethod:`getInsertedId() <phpmethod.MongoDB\\InsertOneResult::getInsertedId>`
353+
:phpmethod:`getInsertedId() <phpmethod.MongoDB\\InsertOneResult::getInsertedId()>`
354354
method returns the ``_id`` of the newly inserted document.
355355

356356
.. tab::
@@ -500,7 +500,7 @@ upper-right to set the language of the examples on this page.
500500
.. tab::
501501
:tabid: php
502502

503-
:phpmethod:`MongoDB\\Collection::insertMany() <phpmethod.MongoDB\\Collection::insertMany>`
503+
:phpmethod:`MongoDB\\Collection::insertMany() <phpmethod.MongoDB\\Collection::insertMany()>`
504504
can insert *multiple* :ref:`documents <bson-document-format>` into a
505505
collection. Pass an array of documents to the method.
506506

@@ -640,12 +640,12 @@ upper-right to set the language of the examples on this page.
640640
:tabid: php
641641

642642
Upon successful insert, the
643-
:phpmethod:`insertMany() <phpmethod.MongoDB\\Collection::insertMany>`
643+
:phpmethod:`insertMany() <phpmethod.MongoDB\\Collection::insertMany()>`
644644
method
645645
returns an instance of
646646
:phpclass:`MongoDB\\InsertManyResult <phpclass.MongoDB\\InsertManyResult>`
647647
whose
648-
:phpmethod:`getInsertedIds() <phpmethod.MongoDB\\InsertManyResult::getInsertedIds>`
648+
:phpmethod:`getInsertedIds() <phpmethod.MongoDB\\InsertManyResult::getInsertedIds()>`
649649
method returns the ``_id`` of each newly inserted document.
650650

651651
To retrieve the inserted documents, :ref:`query the collection
@@ -810,9 +810,9 @@ requested from MongoDB for write operations. For details, see
810810

811811
.. seealso::
812812

813-
- :phpmethod:`MongoDB\\Collection::insertOne() <phpmethod.MongoDB\\Collection::insertOne>`
813+
- :phpmethod:`MongoDB\\Collection::insertOne() <phpmethod.MongoDB\\Collection::insertOne()>`
814814

815-
- :phpmethod:`MongoDB\\Collection::insertMany() <phpmethod.MongoDB\\Collection::insertMany>`
815+
- :phpmethod:`MongoDB\\Collection::insertMany() <phpmethod.MongoDB\\Collection::insertMany()>`
816816

817817
- :ref:`additional-inserts`
818818

source/tutorial/project-fields-from-query-results.txt

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -88,7 +88,7 @@ Return All Fields in Matching Documents
8888
- id: php
8989
content: |
9090
If you do not specify a :term:`projection` document, the
91-
:phpmethod:`find() <phpmethod.MongoDB\\Collection::find>`
91+
:phpmethod:`find() <phpmethod.MongoDB\\Collection::find()>`
9292
method returns all fields in the matching documents.
9393

9494
- id: perl

source/tutorial/query-documents.txt

Lines changed: 6 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -92,7 +92,7 @@ the following SQL statement:
9292
- id: php
9393
content: |
9494
For more information on the syntax of the method, see
95-
:phpmethod:`find() <phpmethod.MongoDB\\Collection::find>`.
95+
:phpmethod:`find() <phpmethod.MongoDB\\Collection::find()>`.
9696

9797
- id: perl
9898
content: |
@@ -354,7 +354,7 @@ Cursor
354354

355355
- id: php
356356
content: |
357-
The :phpmethod:`MongoDB\\Collection::find() <phpmethod.MongoDB\\Collection::find>`
357+
The :phpmethod:`MongoDB\\Collection::find() <phpmethod.MongoDB\\Collection::find()>`
358358
method returns a :doc:`cursor </tutorial/iterate-a-cursor>` to
359359
the matching documents. See the MongoDB PHP Library
360360
documentation for
@@ -533,20 +533,20 @@ Additional Methods and Options
533533

534534
The following methods can also read documents from a collection:
535535

536-
- :phpmethod:`MongoDB\\Collection::findOne() <phpmethod.MongoDB\\Collection::findOne>`
536+
- :phpmethod:`MongoDB\\Collection::findOne() <phpmethod.MongoDB\\Collection::findOne()>`
537537

538538
- In :ref:`aggregation pipeline <aggregation-pipeline>`, the
539539
:pipeline:`$match` pipeline stage provides access to MongoDB
540540
queries. See the MongoDB PHP Library's
541541
:ref:`aggregation example <php-aggregation>`.
542542

543543
.. note::
544-
The :phpmethod:`MongoDB\\Collection::findOne() <phpmethod.MongoDB\\Collection::findOne>`
544+
The :phpmethod:`MongoDB\\Collection::findOne() <phpmethod.MongoDB\\Collection::findOne()>`
545545
method also performs a read operation to return a single
546546
document. Internally, the
547-
:phpmethod:`MongoDB\\Collection::findOne() <phpmethod.MongoDB\\Collection::findOne>`
547+
:phpmethod:`MongoDB\\Collection::findOne() <phpmethod.MongoDB\\Collection::findOne()>`
548548
method is the
549-
:phpmethod:`MongoDB\\Collection::find() <phpmethod.MongoDB\\Collection::find>`
549+
:phpmethod:`MongoDB\\Collection::find() <phpmethod.MongoDB\\Collection::find()>`
550550
method with a limit of 1.
551551

552552
- id: perl

source/tutorial/remove-documents.txt

Lines changed: 7 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -116,8 +116,8 @@ You can delete documents in MongoDB using the following methods:
116116
This page uses the
117117
following `MongoDB PHP Library <https://www.mongodb.com/docs/php-library/current/>`_ methods:
118118

119-
- :phpmethod:`MongoDB\\Collection::deleteMany() <phpmethod.MongoDB\\Collection::deleteMany>`
120-
- :phpmethod:`MongoDB\\Collection::deleteOne() <phpmethod.MongoDB\\Collection::deleteOne>`
119+
- :phpmethod:`MongoDB\\Collection::deleteMany() <phpmethod.MongoDB\\Collection::deleteMany()>`
120+
- :phpmethod:`MongoDB\\Collection::deleteOne() <phpmethod.MongoDB\\Collection::deleteOne()>`
121121

122122
.. include:: /includes/driver-examples/examples-intro.rst
123123

@@ -249,7 +249,7 @@ Delete All Documents
249249

250250
To delete all documents from a collection, pass an empty
251251
:ref:`filter<document-query-filter>` document ``[]`` to the
252-
:phpmethod:`MongoDB\\Collection::deleteMany() <phpmethod.MongoDB\\Collection::deleteMany>`
252+
:phpmethod:`MongoDB\\Collection::deleteMany() <phpmethod.MongoDB\\Collection::deleteMany()>`
253253
method.
254254

255255
.. include:: /includes/fact-delete-all-inventory.rst
@@ -419,7 +419,7 @@ Delete All Documents that Match a Condition
419419

420420
To delete all documents that match a deletion criteria, pass a
421421
:ref:`filter <document-query-filter>` parameter to the
422-
:phpmethod:`deleteMany() <phpmethod.MongoDB\\Collection::deleteMany>`
422+
:phpmethod:`deleteMany() <phpmethod.MongoDB\\Collection::deleteMany()>`
423423
method.
424424

425425
.. include:: /includes/fact-remove-condition-inv-example.rst
@@ -601,7 +601,7 @@ Delete Only One Document that Matches a Condition
601601
To delete at most a single document that matches a specified
602602
filter (even though multiple documents may match the specified
603603
filter) use the
604-
:phpmethod:`MongoDB\\Collection::deleteOne() <phpmethod.MongoDB\\Collection::deleteOne>`
604+
:phpmethod:`MongoDB\\Collection::deleteOne() <phpmethod.MongoDB\\Collection::deleteOne()>`
605605
method.
606606

607607
.. include:: /includes/fact-remove-one-condition-inv-example.rst
@@ -823,9 +823,9 @@ requested from MongoDB for write operations. For details, see
823823
content: |
824824
.. seealso::
825825

826-
- :phpmethod:`MongoDB\\Collection::deleteMany() <phpmethod.MongoDB\\Collection::deleteMany>`
826+
- :phpmethod:`MongoDB\\Collection::deleteMany() <phpmethod.MongoDB\\Collection::deleteMany()>`
827827

828-
- :phpmethod:`MongoDB\\Collection::deleteOne() <phpmethod.MongoDB\\Collection::deleteOne>`
828+
- :phpmethod:`MongoDB\\Collection::deleteOne() <phpmethod.MongoDB\\Collection::deleteOne()>`
829829

830830
- :ref:`additional-deletes`
831831

source/tutorial/update-documents.txt

Lines changed: 12 additions & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -151,11 +151,11 @@ upper-right to set the language of the following examples.
151151
This page uses the following `MongoDB PHP Library
152152
<https://www.mongodb.com/docs/php-library/current/>`_ methods:
153153

154-
- :phpmethod:`MongoDB\\Collection::updateOne() <phpmethod.MongoDB\\Collection::updateOne>`
154+
- :phpmethod:`MongoDB\\Collection::updateOne() <phpmethod.MongoDB\\Collection::updateOne()>`
155155

156-
- :phpmethod:`MongoDB\\Collection::updateMany() <phpmethod.MongoDB\\Collection::updateMany>`
156+
- :phpmethod:`MongoDB\\Collection::updateMany() <phpmethod.MongoDB\\Collection::updateMany()>`
157157

158-
- :phpmethod:`MongoDB\\Collection::replaceOne() <phpmethod.MongoDB\\Collection::replaceOne>`
158+
- :phpmethod:`MongoDB\\Collection::replaceOne() <phpmethod.MongoDB\\Collection::replaceOne()>`
159159

160160
|populate-inventory|
161161

@@ -579,7 +579,7 @@ Update a Single Document
579579
:tabid: php
580580

581581
The following example uses the :phpmethod:`updateOne()
582-
<phpmethod.MongoDB\\Collection::updateOne>` method on the
582+
<phpmethod.MongoDB\\Collection::updateOne()>` method on the
583583
``inventory`` collection to update the *first* document where
584584
``item`` equals ``"paper"``:
585585

@@ -695,7 +695,7 @@ Update Multiple Documents
695695
:tabid: php
696696

697697
The following example uses the :phpmethod:`updateMany()
698-
<phpmethod.MongoDB\\Collection::updateMany>` method on the
698+
<phpmethod.MongoDB\\Collection::updateMany()>` method on the
699699
``inventory`` collection to update all documents where ``qty`` is
700700
less than ``50``:
701701

@@ -817,7 +817,7 @@ Replace a Document
817817
To replace the entire content of a document except for the ``_id``
818818
field, pass an entirely new document as the second argument to
819819
:phpmethod:`replaceOne()
820-
<phpmethod.MongoDB\\Collection::replaceOne>`.
820+
<phpmethod.MongoDB\\Collection::replaceOne()>`.
821821

822822
.. include:: /includes/fact-update-replace-example.rst
823823

@@ -1059,11 +1059,11 @@ Upsert Option
10591059
:tabid: php
10601060

10611061
If :phpmethod:`updateOne()
1062-
<phpmethod.MongoDB\\Collection::updateOne>`,
1062+
<phpmethod.MongoDB\\Collection::updateOne()>`,
10631063
:phpmethod:`updateMany()
1064-
<phpmethod.MongoDB\\Collection::updateMany>`, or
1064+
<phpmethod.MongoDB\\Collection::updateMany()>`, or
10651065
:phpmethod:`replaceOne()
1066-
<phpmethod.MongoDB\\Collection::replaceOne>` includes ``upsert =>
1066+
<phpmethod.MongoDB\\Collection::replaceOne()>` includes ``upsert =>
10671067
true`` **and** no documents match the specified filter, then the
10681068
operation creates a new document and inserts it. If there are
10691069
matching documents, then the operation modifies or replaces the
@@ -1256,11 +1256,11 @@ requested from MongoDB for write operations. For details, see
12561256

12571257
.. seealso::
12581258

1259-
- :phpmethod:`MongoDB\\Collection::updateOne() <phpmethod.MongoDB\\Collection::updateOne>`
1259+
- :phpmethod:`MongoDB\\Collection::updateOne() <phpmethod.MongoDB\\Collection::updateOne()>`
12601260

1261-
- :phpmethod:`MongoDB\\Collection::updateMany() <phpmethod.MongoDB\\Collection::updateMany>`
1261+
- :phpmethod:`MongoDB\\Collection::updateMany() <phpmethod.MongoDB\\Collection::updateMany()>`
12621262

1263-
- :phpmethod:`MongoDB\\Collection::replaceOne() <phpmethod.MongoDB\\Collection::replaceOne>`
1263+
- :phpmethod:`MongoDB\\Collection::replaceOne() <phpmethod.MongoDB\\Collection::replaceOne()>`
12641264

12651265
- :ref:`additional-updates`
12661266

0 commit comments

Comments
 (0)