Skip to content

Commit 122f58f

Browse files
committed
review comments
1 parent de61ae1 commit 122f58f

8 files changed

+20
-31
lines changed

source/reference/class/MongoDBCollection.txt

Lines changed: 0 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,3 @@
1-
.. _api-mongodb-collection-class:
2-
31
=========================
42
MongoDB\\Collection Class
53
=========================

source/reference/function/add_logger.txt

Lines changed: 0 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,3 @@
1-
.. _api-add-logger:
2-
31
=====================
42
MongoDB\\add_logger()
53
=====================

source/reference/function/remove_logger.txt

Lines changed: 0 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,3 @@
1-
.. _api-remove-logger:
2-
31
========================
42
MongoDB\\remove_logger()
53
========================

source/reference/method/MongoDBClient-addSubscriber.txt

Lines changed: 0 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,3 @@
1-
.. _api-client-add-subscriber:
2-
31
================================
42
MongoDB\\Client::addSubscriber()
53
================================

source/reference/method/MongoDBClient-removeSubscriber.txt

Lines changed: 0 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,3 @@
1-
.. _api-client-remove-subscriber:
2-
31
===================================
42
MongoDB\\Client::removeSubscriber()
53
===================================

source/reference/method/MongoDBDatabase-createEncryptedCollection.txt

Lines changed: 0 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,3 @@
1-
.. _api-database-create-encrypted:
2-
31
==============================================
42
MongoDB\\Database::createEncryptedCollection()
53
==============================================

source/reference/method/MongoDBGridFSBucket-registerGlobalStreamWrapperAlias.txt

Lines changed: 0 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,3 @@
1-
.. _api-gridfs-bucket-register-global:
2-
31
===========================================================
42
MongoDB\\GridFS\\Bucket::registerGlobalStreamWrapperAlias()
53
===========================================================

source/whats-new.txt

Lines changed: 20 additions & 17 deletions
Original file line numberDiff line numberDiff line change
@@ -35,28 +35,28 @@ following versions of the {+php-library+}:
3535
What's New in 1.20
3636
------------------
3737

38-
.. important:: MongoDB Server v3.6 End-of-Life
38+
.. important:: {+mdb-server+} v3.6 End-of-Life
3939

40-
Support for MongoDB Server v3.6 is removed in this release of the
40+
Support for {+mdb-server+} v3.6 is removed in this release of the
4141
library.
4242

43-
- Adds support for MongoDB Server v8.0.
43+
- Adds support for {+mdb-server+} v8.0.
4444

4545
.. _php-lib-version-1.18:
4646

4747
What's New in 1.18
4848
------------------
4949

5050
- Adds a new GridFS API to make it more convenient to work with files using PHP's
51-
existing filesystem functions. The :ref:`MongoDB\GridFS\Bucket::registerGlobalStreamWrapperAlias() <api-gridfs-bucket-register-global>`
51+
existing filesystem functions. The :phpmethod:`MongoDB\GridFS\Bucket::registerGlobalStreamWrapperAlias()`
5252
method may be used to register a global alias for a GridFS bucket. After
53-
doing so, files within that bucket can be accessed using only a file URI
53+
doing so, files within that bucket can be accessed by using only a file URI
5454
(e.g. "gridfs://mybucket/hello.txt"). A demonstration of this API can be found
5555
in the `gridfs_stream_wrapper.php <https://github.com/mongodb/mongo-php-library/blob/1.18.0/examples/gridfs_stream_wrapper.php>`__
5656
example script.
5757

58-
- Adds :ref:`addSubscriber() <api-client-add-subscriber>` and
59-
:ref:`removeSubscriber()<api-client-remove-subscriber>` methods to the
58+
- Adds :phpmethod:`MongoDB\Client::addSubscriber()` and
59+
:phpmethod:`MongoDB\Client::removeSubscriber()` methods to the
6060
``MongoDB\Client`` class to make it easier to register monitoring classes
6161
on the underlying ``MongoDB\Driver\Manager`` object.
6262

@@ -72,17 +72,20 @@ What's New in 1.17
7272
More information on this feature may be found in the
7373
:ref:`Codecs tutorial <php-codecs>`.
7474

75-
- Adds :ref:`MongoDB\add_logger() <api-add-logger>` and
76-
:ref:`MongoDB\remove_logger() <api-remove-logger>` functions to the library.
75+
- Adds :phpmethod:`MongoDB\add_logger()` and
76+
:phpmethod:`MongoDB\remove_logger()` functions to the library.
7777
These functions allow applications to register a `PSR-3 Logger <https://www.php-fig.org/psr/psr-3/>`__
7878
to receive log messages emitted by the driver. Previously, logs were only
7979
accessible via the extension's `mongodb.debug <https://www.php.net/manual/en/mongodb.configuration.php#ini.mongodb.debug>`__
8080
INI setting.
8181

82-
- Introduces new :ref:`MongoDB\Collection <api-mongodb-collection-class>` methods
83-
to create and manage :atlas:`Atlas Search indexes </atlas-search>`. Atlas
84-
Search indexes can be queried using the :manual:`$search </reference/operator/aggregation/search/>`
82+
- Introduces new :phpclass:`MongoDB\Collection` methods to create and manage
83+
Atlas Search indexes. Atlas Search indexes can be queried using the ``$search``
8584
aggregation pipeline stage, which is supported in all versions of the library.
85+
To learn more about Atlas Search indexes and the specfics of the ``$search``
86+
aggregation stage, see the :atlas:`Atlas Search indexes </atlas-search>`
87+
documentation and :manual:`$search </reference/operator/aggregation/search/>`,
88+
respectively.
8689

8790
- Upgrades the ``mongodb`` extension requirement to 1.17.0. Support for PHP
8891
7.2 and 7.3 has been removed and the library now requires PHP 7.4 or newer.
@@ -97,7 +100,7 @@ What's New in 1.16
97100

98101
- Introduces support for :v7.0:`MongoDB 7.0 </release-notes/7.0>`.
99102

100-
- Introduces :ref:`MongoDB\Database::createEncryptedCollection() <api-database-create-encrypted>`.
103+
- Introduces :phpmethod:`MongoDB\Database::createEncryptedCollection()`.
101104
This method automatically creates data encryption keys when creating a new
102105
encrypted collection.
103106

@@ -111,18 +114,18 @@ To learn more about this release, see the `v1.16 Release Notes
111114
What's New in 1.15
112115
------------------
113116

114-
- Adds new ``examples/`` and ``tools/`` directories to library repository,
117+
- Adds new ``examples/`` and ``tools/`` directories to the library repository,
115118
which contain code snippets and scripts that may prove useful when writing
116119
or debugging applications, respectively. These directories are intended to
117-
supplement the library's existing documentation, and will be added to over time.
120+
supplement the library's existing documentation and will be added to over time.
118121

119-
- Various backwards compatible typing improvements have been made throughout the
122+
- Adds various backwards compatible typing improvements throughout the
120123
library. Downstream impact for these changes are discussed in
121124
`UPGRADE-1.15.md <https://github.com/mongodb/mongo-php-library/blob/1.15.0/UPGRADE-1.15.md>`__.
122125

123126
- Integrates `Psalm <https://psalm.dev/>`__ for static analysis.
124127

125-
- This release upgrades the ``mongodb`` extension requirement to 1.15.0.
128+
- Upgrades the ``mongodb`` extension requirement to 1.15.0.
126129

127130
To learn more about this release, see the `v1.15 Release Notes
128131
<https://github.com/mongodb/mongo-php-library/releases/tag/1.15.0>`__ on GitHub.

0 commit comments

Comments
 (0)