Skip to content

Commit 902fb55

Browse files
committed
DOCSP-36627: Additional double backslash fixes for v1.17
1 parent ab679d8 commit 902fb55

11 files changed

+40
-40
lines changed

docs/includes/extracts-note.yaml

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -22,7 +22,7 @@ ref: note-atlas-search-async
2222
content: |
2323
Atlas Search indexes are managed asynchronously. After creating or updating an
2424
index, you can periodically execute
25-
:phpmethod:`MongoDB\\Collection::listSearchIndexes()` and check the
25+
:phpmethod:`MongoDB\Collection::listSearchIndexes()` and check the
2626
``queryable`` :manual:`output field </reference/operator/aggregation/listSearchIndexes/#output>`
2727
to determine whether it is ready to be used.
2828
...

docs/reference/function/add_logger.txt

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -15,7 +15,7 @@ MongoDB\\add_logger()
1515
Definition
1616
----------
1717

18-
.. phpmethod:: MongoDB\\add_logger()
18+
.. phpmethod:: MongoDB\add_logger()
1919

2020
Registers a PSR logger to receive log messages from the driver.
2121

@@ -35,7 +35,7 @@ Behavior
3535
--------
3636

3737
This function allows the application to register one or more
38-
`Psr\\Log\\LoggerInterface <https://www.php-fig.org/psr/psr-3/#3-psrlogloggerinterface>`__
38+
`Psr\Log\LoggerInterface <https://www.php-fig.org/psr/psr-3/#3-psrlogloggerinterface>`__
3939
objects to receive log messages from libmongoc and the driver. Each registered
4040
logger will receive messages for *all* clients.
4141

@@ -58,6 +58,6 @@ Errors/Exceptions
5858
See Also
5959
--------
6060

61-
- :phpmethod:`MongoDB\\remove_logger()`
61+
- :phpmethod:`MongoDB\remove_logger()`
6262
- `PSR-3: Logger Interface <https://www.php-fig.org/psr/psr-3/>`__
6363
- `libmongoc: Logging <https://mongoc.org/libmongoc/current/logging.html>`__

docs/reference/function/remove_logger.txt

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -15,7 +15,7 @@ MongoDB\\remove_logger()
1515
Definition
1616
----------
1717

18-
.. phpmethod:: MongoDB\\remove_logger()
18+
.. phpmethod:: MongoDB\remove_logger()
1919

2020
Unregisters a PSR logger to no longer receive log messages from the driver.
2121

@@ -26,7 +26,7 @@ Definition
2626
Parameters
2727
----------
2828

29-
``$logger`` : Psr\\Log\\LoggerInterface
29+
``$logger`` : Psr\Log\LoggerInterface
3030
A logger to unregister.
3131

3232
If the logger is not registered, the method will have no effect.
@@ -39,6 +39,6 @@ Errors/Exceptions
3939
See Also
4040
--------
4141

42-
- :phpmethod:`MongoDB\\add_logger()`
42+
- :phpmethod:`MongoDB\add_logger()`
4343
- `PSR-3: Logger Interface <https://www.php-fig.org/psr/psr-3/>`__
4444
- `libmongoc: Logging <https://mongoc.org/libmongoc/current/logging.html>`__

docs/reference/method/MongoDBCollection-createSearchIndex.txt

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -15,7 +15,7 @@ MongoDB\\Collection::createSearchIndex()
1515
Definition
1616
----------
1717

18-
.. phpmethod:: MongoDB\\Collection::createSearchIndex()
18+
.. phpmethod:: MongoDB\Collection::createSearchIndex()
1919

2020
Create an Atlas Search index for the collection.
2121

@@ -107,10 +107,10 @@ The output would then resemble:
107107
See Also
108108
--------
109109

110-
- :phpmethod:`MongoDB\\Collection::createSearchIndexes()`
111-
- :phpmethod:`MongoDB\\Collection::dropSearchIndex()`
112-
- :phpmethod:`MongoDB\\Collection::listSearchIndexes()`
113-
- :phpmethod:`MongoDB\\Collection::updateSearchIndex()`
110+
- :phpmethod:`MongoDB\Collection::createSearchIndexes()`
111+
- :phpmethod:`MongoDB\Collection::dropSearchIndex()`
112+
- :phpmethod:`MongoDB\Collection::listSearchIndexes()`
113+
- :phpmethod:`MongoDB\Collection::updateSearchIndex()`
114114
- :manual:`createSearchIndexes </reference/command/createSearchIndexes>` command
115115
reference in the MongoDB manual
116116
- `Atlas Search <https://www.mongodb.com/docs/atlas/atlas-search/>`__ documentation in the MongoDB Manual

docs/reference/method/MongoDBCollection-createSearchIndexes.txt

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -15,7 +15,7 @@ MongoDB\\Collection::createSearchIndexes()
1515
Definition
1616
----------
1717

18-
.. phpmethod:: MongoDB\\Collection::createSearchIndexes()
18+
.. phpmethod:: MongoDB\Collection::createSearchIndexes()
1919

2020
Create one or more Atlas Search indexes for the collection.
2121

@@ -114,10 +114,10 @@ The output would then resemble:
114114
See Also
115115
--------
116116

117-
- :phpmethod:`MongoDB\\Collection::createSearchIndex()`
118-
- :phpmethod:`MongoDB\\Collection::dropSearchIndex()`
119-
- :phpmethod:`MongoDB\\Collection::listSearchIndexes()`
120-
- :phpmethod:`MongoDB\\Collection::updateSearchIndex()`
117+
- :phpmethod:`MongoDB\Collection::createSearchIndex()`
118+
- :phpmethod:`MongoDB\Collection::dropSearchIndex()`
119+
- :phpmethod:`MongoDB\Collection::listSearchIndexes()`
120+
- :phpmethod:`MongoDB\Collection::updateSearchIndex()`
121121
- :manual:`createSearchIndexes </reference/command/createSearchIndexes>` command
122122
reference in the MongoDB manual
123123
- `Atlas Search <https://www.mongodb.com/docs/atlas/atlas-search/>`__ documentation in the MongoDB Manual

docs/reference/method/MongoDBCollection-dropSearchIndex.txt

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -15,7 +15,7 @@ MongoDB\\Collection::dropSearchIndex()
1515
Definition
1616
----------
1717

18-
.. phpmethod:: MongoDB\\Collection::dropSearchIndex()
18+
.. phpmethod:: MongoDB\Collection::dropSearchIndex()
1919

2020
Drop an Atlas Search index for the collection.
2121

@@ -56,10 +56,10 @@ Errors/Exceptions
5656
See Also
5757
--------
5858

59-
- :phpmethod:`MongoDB\\Collection::createSearchIndex()`
60-
- :phpmethod:`MongoDB\\Collection::createSearchIndexes()`
61-
- :phpmethod:`MongoDB\\Collection::listSearchIndexes()`
62-
- :phpmethod:`MongoDB\\Collection::updateSearchIndex()`
59+
- :phpmethod:`MongoDB\Collection::createSearchIndex()`
60+
- :phpmethod:`MongoDB\Collection::createSearchIndexes()`
61+
- :phpmethod:`MongoDB\Collection::listSearchIndexes()`
62+
- :phpmethod:`MongoDB\Collection::updateSearchIndex()`
6363
- :manual:`dropSearchIndex </reference/command/dropSearchIndex>` command
6464
reference in the MongoDB manual
6565
- `Atlas Search <https://www.mongodb.com/docs/atlas/atlas-search/>`__ documentation in the MongoDB Manual

docs/reference/method/MongoDBCollection-listSearchIndexes.txt

Lines changed: 8 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -15,7 +15,7 @@ MongoDB\\Collection::listSearchIndexes()
1515
Definition
1616
----------
1717

18-
.. phpmethod:: MongoDB\\Collection::listSearchIndexes()
18+
.. phpmethod:: MongoDB\Collection::listSearchIndexes()
1919

2020
Gets index information for one or more search indexes in the collection.
2121

@@ -72,17 +72,17 @@ Parameters
7272
will be returned.
7373

7474
* - readConcern
75-
- :php:`MongoDB\\Driver\\ReadConcern <class.mongodb-driver-readconcern>`
75+
- :php:`MongoDB\Driver\ReadConcern <class.mongodb-driver-readconcern>`
7676
- .. include:: /includes/extracts/collection-option-readConcern.rst
7777

7878
.. include:: /includes/extracts/common-option-readConcern-transaction.rst
7979

8080
* - readPreference
81-
- :php:`MongoDB\\Driver\\ReadPreference <class.mongodb-driver-readpreference>`
81+
- :php:`MongoDB\Driver\ReadPreference <class.mongodb-driver-readpreference>`
8282
- .. include:: /includes/extracts/collection-option-readPreference.rst
8383

8484
* - session
85-
- :php:`MongoDB\\Driver\\Session <class.mongodb-driver-session>`
85+
- :php:`MongoDB\Driver\Session <class.mongodb-driver-session>`
8686
- .. include:: /includes/extracts/common-option-session.rst
8787

8888
* - typeMap
@@ -107,10 +107,10 @@ Errors/Exceptions
107107
See Also
108108
--------
109109

110-
- :phpmethod:`MongoDB\\Collection::createSearchIndex()`
111-
- :phpmethod:`MongoDB\\Collection::createSearchIndexes()`
112-
- :phpmethod:`MongoDB\\Collection::dropSearchIndex()`
113-
- :phpmethod:`MongoDB\\Collection::updateSearchIndex()`
110+
- :phpmethod:`MongoDB\Collection::createSearchIndex()`
111+
- :phpmethod:`MongoDB\Collection::createSearchIndexes()`
112+
- :phpmethod:`MongoDB\Collection::dropSearchIndex()`
113+
- :phpmethod:`MongoDB\Collection::updateSearchIndex()`
114114
- :manual:`$listSearchIndexes </reference/operator/aggregation/listSearchIndexes>`
115115
aggregation pipeline stage reference in the MongoDB manual
116116
- `Atlas Search <https://www.mongodb.com/docs/atlas/atlas-search/>`__ documentation in the MongoDB Manual

docs/reference/method/MongoDBCollection-updateSearchIndex.txt

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -15,7 +15,7 @@ MongoDB\\Collection::updateSearchIndex()
1515
Definition
1616
----------
1717

18-
.. phpmethod:: MongoDB\\Collection::updateSearchIndex()
18+
.. phpmethod:: MongoDB\Collection::updateSearchIndex()
1919

2020
Update an Atlas Search index for the collection.
2121

@@ -71,10 +71,10 @@ Behavior
7171
See Also
7272
--------
7373

74-
- :phpmethod:`MongoDB\\Collection::createSearchIndex()`
75-
- :phpmethod:`MongoDB\\Collection::createSearchIndexes()`
76-
- :phpmethod:`MongoDB\\Collection::dropSearchIndex()`
77-
- :phpmethod:`MongoDB\\Collection::listSearchIndexes()`
74+
- :phpmethod:`MongoDB\Collection::createSearchIndex()`
75+
- :phpmethod:`MongoDB\Collection::createSearchIndexes()`
76+
- :phpmethod:`MongoDB\Collection::dropSearchIndex()`
77+
- :phpmethod:`MongoDB\Collection::listSearchIndexes()`
7878
- :manual:`updateSearchIndex </reference/command/updateSearchIndex>` command
7979
reference in the MongoDB manual
8080
- `Atlas Search <https://www.mongodb.com/docs/atlas/atlas-search/>`__ documentation in the MongoDB Manual

docs/tutorial/codecs.txt

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -42,7 +42,7 @@ The example above selects a collection and instructs it to use the ``PersonCodec
4242
When inserting data, the ``PersonCodec`` is used to encode the document. When retrieving data, the same ``PersonCodec``
4343
is used to decode BSON data into a ``Person`` instance. Note that while the ``PersonCodec`` could technically decode any
4444
BSON document that contains a name field, we wouldn't want to use it for any other documents. Document codecs are meant
45-
to be used with a :phpclass:`MongoDB\\Collection`, or when decoding embedded documents.
45+
to be used with a :phpclass:`MongoDB\Collection`, or when decoding embedded documents.
4646

4747
When using a collection with a codec, the codec will only accept and return data of that type for certain operations.
4848
Insert and replace operations (e.g. ``insertOne``, ```findOneAndReplace``, and some ``bulkWrite`` operations) will

docs/tutorial/custom-types.txt

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -6,7 +6,7 @@ Custom Data-Types
66

77
.. note::
88

9-
This tutorial explains implementing custom data types using the :php:`MongoDB\\BSON\\Persistable <class.mongodb-bson-persistable>`
9+
This tutorial explains implementing custom data types using the :php:`MongoDB\BSON\Persistable <class.mongodb-bson-persistable>`
1010
interface found in the MongoDB extension. Consider using a codec instead to decouple the MongoDB persistence logic
1111
from your business logic. See the :ref:`codec tutorial <php-codec-handling-data-types>` for an example.
1212

docs/tutorial/encryption.txt

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -91,7 +91,7 @@ Creating an Encryption Key
9191
and thus it is very important that you keep this key secure.
9292

9393
To create an encryption key, create a
94-
:php:`MongoDB\\Driver\\ClientEncryption <class.mongodb-driver-clientencryption>`
94+
:php:`MongoDB\Driver\ClientEncryption <class.mongodb-driver-clientencryption>`
9595
instance with encryption options and use the
9696
:php:`createDataKey() <manual/en/mongodb-driver-clientencryption.createdatakey.php>`
9797
method. The method will return the key ID which can be used to reference the key
@@ -157,7 +157,7 @@ specifying the ``autoEncryption``
157157
:php:`driver option <manual/en/mongodb-driver-manager.construct.php#mongodb-driver-manager.construct-driveroptions>`.
158158
The following examples demonstrate how to setup automatic client-side field
159159
level encryption and use a
160-
:php:`MongoDB\\Driver\\ClientEncryption <class.mongodb-driver-clientencryption>`
160+
:php:`MongoDB\Driver\ClientEncryption <class.mongodb-driver-clientencryption>`
161161
object to create a new encryption key.
162162

163163

@@ -209,7 +209,7 @@ Explicit Encryption
209209

210210
Explicit encryption is a MongoDB community feature and does not use
211211
crypt_shared_ or mongocryptd_. Explicit encryption is provided by the
212-
:php:`MongoDB\\Driver\\ClientEncryption <mongodb-driver-clientencryption>` class.
212+
:php:`MongoDB\Driver\ClientEncryption <mongodb-driver-clientencryption>` class.
213213

214214
.. literalinclude:: /examples/encryption/csfle-explicit_encryption.php
215215
:language: php

0 commit comments

Comments
 (0)