Skip to content

Commit 3cc5732

Browse files
committed
PHPLIB-234: Use "Return Values" section headings
1 parent 7288472 commit 3cc5732

File tree

53 files changed

+198
-156
lines changed

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

53 files changed

+198
-156
lines changed

docs/reference/method/MongoDBClient-dropDatabase.txt

Lines changed: 5 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -29,11 +29,12 @@ Definition
2929

3030
.. include:: /includes/apiargs/MongoDBClient-method-dropDatabase-option.rst
3131

32-
:returns:
32+
Return Values
33+
-------------
3334

34-
An array or object with the result document of the :manual:`dropDatabase
35-
</reference/command/dropDatabase>` command. The return type will depend on
36-
the ``typeMap`` option.
35+
An array or object with the result document of the :manual:`dropDatabase
36+
</reference/command/dropDatabase>` command. The return type will depend on the
37+
``typeMap`` option.
3738

3839
Example
3940
-------

docs/reference/method/MongoDBClient-getManager.txt

Lines changed: 3 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -23,9 +23,10 @@ Definition
2323

2424
function getManager(): MongoDB\Manager
2525

26-
:returns:
26+
Return Values
27+
-------------
2728

28-
A :php:`MongoDB\\Driver\\Manager <class.mongodb-driver-manager>` object.
29+
A :php:`MongoDB\\Driver\\Manager <class.mongodb-driver-manager>` object.
2930

3031
See Also
3132
--------

docs/reference/method/MongoDBClient-listDatabases.txt

Lines changed: 5 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -29,11 +29,12 @@ Definition
2929

3030
.. include:: /includes/apiargs/MongoDBClient-method-listDatabases-option.rst
3131

32-
:returns:
32+
Return Values
33+
-------------
3334

34-
A traversable :phpclass:`MongoDB\\Model\\DatabaseInfoIterator`, which
35-
contains an :phpclass:`MongoDB\\Model\\DatabaseInfo` object for each
36-
database on the server.
35+
A traversable :phpclass:`MongoDB\\Model\\DatabaseInfoIterator`, which contains
36+
a :phpclass:`MongoDB\\Model\\DatabaseInfo` object for each database on the
37+
server.
3738

3839
Example
3940
-------

docs/reference/method/MongoDBClient-selectCollection.txt

Lines changed: 3 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -29,9 +29,10 @@ Definition
2929

3030
.. include:: /includes/apiargs/MongoDBClient-method-selectCollection-option.rst
3131

32-
:returns:
32+
Return Values
33+
-------------
3334

34-
A :phpclass:`MongoDB\\Collection` object.
35+
A :phpclass:`MongoDB\\Collection` object.
3536

3637
Behavior
3738
--------

docs/reference/method/MongoDBClient-selectDatabase.txt

Lines changed: 3 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -29,9 +29,10 @@ Definition
2929

3030
.. include:: /includes/apiargs/MongoDBClient-method-selectDatabase-option.rst
3131

32-
:returns:
32+
Return Values
33+
-------------
3334

34-
A :phpclass:`MongoDB\\Database` object.
35+
A :phpclass:`MongoDB\\Database` object.
3536

3637
Behavior
3738
--------

docs/reference/method/MongoDBClient__get.txt

Lines changed: 3 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -27,9 +27,10 @@ Definition
2727

2828
.. include:: /includes/apiargs/MongoDBClient-method-get-param.rst
2929

30-
:returns:
30+
Return Values
31+
-------------
3132

32-
A :phpclass:`MongoDB\\Database` object.
33+
A :phpclass:`MongoDB\\Database` object.
3334

3435
Behavior
3536
--------

docs/reference/method/MongoDBCollection-aggregate.txt

Lines changed: 5 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -30,11 +30,12 @@ Definition
3030

3131
.. include:: /includes/apiargs/MongoDBCollection-method-aggregate-option.rst
3232

33-
:returns:
33+
Return Values
34+
-------------
3435

35-
A :php:`MongoDB\\Driver\\Cursor <class.mongodb-driver-cursor>` or
36-
:php:`ArrayIterator <arrayiterator>` object. In both cases, the return
37-
value will be :php:`Traversable <traversable>`.
36+
A :php:`MongoDB\\Driver\\Cursor <class.mongodb-driver-cursor>` or
37+
:php:`ArrayIterator <arrayiterator>` object. In both cases, the return value
38+
will be :php:`Traversable <traversable>`.
3839

3940
.. _php-agg-method-behavior:
4041

docs/reference/method/MongoDBCollection-bulkWrite.txt

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -29,11 +29,11 @@ Definition
2929

3030
.. include:: /includes/apiargs/MongoDBCollection-method-bulkWrite-option.rst
3131

32-
:returns:
32+
Return Values
33+
-------------
3334

34-
A :phpclass:`MongoDB\\BulkWriteResult` object, which encapsulates a
35-
:php:`MongoDB\\Driver\\WriteResult <class.mongodb-driver-writeresult>`
36-
object.
35+
A :phpclass:`MongoDB\\BulkWriteResult` object, which encapsulates a
36+
:php:`MongoDB\\Driver\\WriteResult <class.mongodb-driver-writeresult>` object.
3737

3838
.. todo: add output and examples
3939

docs/reference/method/MongoDBCollection-count.txt

Lines changed: 3 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -29,9 +29,10 @@ Definition
2929

3030
.. include:: /includes/apiargs/MongoDBCollection-method-count-option.rst
3131

32-
:returns:
32+
Return Values
33+
-------------
3334

34-
The number of documents matching the filter criteria.
35+
The number of documents matching the filter criteria.
3536

3637
.. todo: add output and examples
3738

docs/reference/method/MongoDBCollection-createIndex.txt

Lines changed: 3 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -34,9 +34,10 @@ Definition
3434
:manual:`createIndexes </reference/command/createIndexes>` command reference
3535
in the MongoDB manual.
3636

37-
:returns:
37+
Return Values
38+
-------------
3839

39-
The name of the created index as a string.
40+
The name of the created index as a string.
4041

4142
Examples
4243
--------

docs/reference/method/MongoDBCollection-createIndexes.txt

Lines changed: 3 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -29,9 +29,10 @@ Definition
2929

3030
.. include:: /includes/apiargs/MongoDBCollection-method-createIndexes-option.rst
3131

32-
:returns:
32+
Return Values
33+
-------------
3334

34-
The names of the created indexes as an array of strings.
35+
The names of the created indexes as an array of strings.
3536

3637
``$indexes`` parameter
3738
----------------------

docs/reference/method/MongoDBCollection-deleteMany.txt

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -29,11 +29,11 @@ Definition
2929

3030
.. include:: /includes/apiargs/MongoDBCollection-method-deleteMany-option.rst
3131

32-
:returns:
32+
Return Values
33+
-------------
3334

34-
A :phpclass:`MongoDB\\DeleteResult` object, which encapsulates a
35-
:php:`MongoDB\\Driver\\WriteResult <class.mongodb-driver-writeresult>`
36-
object.
35+
A :phpclass:`MongoDB\\DeleteResult` object, which encapsulates a
36+
:php:`MongoDB\\Driver\\WriteResult <class.mongodb-driver-writeresult>` object.
3737

3838
Example
3939
-------

docs/reference/method/MongoDBCollection-deleteOne.txt

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -31,11 +31,11 @@ Definition
3131

3232
.. include:: /includes/apiargs/MongoDBCollection-method-deleteOne-option.rst
3333

34-
:returns:
34+
Return Values
35+
-------------
3536

36-
A :phpclass:`MongoDB\\DeleteResult` object, which encapsulates a
37-
:php:`MongoDB\\Driver\\WriteResult <class.mongodb-driver-writeresult>`
38-
object.
37+
A :phpclass:`MongoDB\\DeleteResult` object, which encapsulates a
38+
:php:`MongoDB\\Driver\\WriteResult <class.mongodb-driver-writeresult>` object.
3939

4040
Example
4141
-------

docs/reference/method/MongoDBCollection-distinct.txt

Lines changed: 3 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -29,9 +29,10 @@ Definition
2929

3030
.. include:: /includes/apiargs/MongoDBCollection-method-distinct-option.rst
3131

32-
:returns:
32+
Return Values
33+
-------------
3334

34-
An array of the distinct values.
35+
An array of the distinct values.
3536

3637
Examples
3738
--------

docs/reference/method/MongoDBCollection-drop.txt

Lines changed: 5 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -29,11 +29,12 @@ Definition
2929

3030
.. include:: /includes/apiargs/MongoDBCollection-method-drop-option.rst
3131

32-
:returns:
32+
Return Values
33+
-------------
3334

34-
An array or object with the result document of the :manual:`drop
35-
</reference/command/drop>` command. The return type will depend on the
36-
``typeMap`` option.
35+
An array or object with the result document of the :manual:`drop
36+
</reference/command/drop>` command. The return type will depend on the
37+
``typeMap`` option.
3738

3839
Example
3940
-------

docs/reference/method/MongoDBCollection-dropIndex.txt

Lines changed: 5 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -29,11 +29,12 @@ Definition
2929

3030
.. include:: /includes/apiargs/MongoDBCollection-method-dropIndex-option.rst
3131

32-
:returns:
32+
Return Values
33+
-------------
3334

34-
An array or object with the result document of the :manual:`dropIndexes
35-
</reference/command/dropIndexes>` command. The return type will depend on
36-
the ``typeMap`` option.
35+
An array or object with the result document of the :manual:`dropIndexes
36+
</reference/command/dropIndexes>` command. The return type will depend on the
37+
``typeMap`` option.
3738

3839
Example
3940
-------

docs/reference/method/MongoDBCollection-dropIndexes.txt

Lines changed: 5 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -30,11 +30,12 @@ Definition
3030

3131
.. include:: /includes/apiargs/MongoDBCollection-method-dropIndex-option.rst
3232

33-
:returns:
33+
Return Values
34+
-------------
3435

35-
An array or object with the result document of the :manual:`dropIndexes
36-
</reference/command/dropIndexes>` command. The return type will depend on
37-
the ``typeMap`` option.
36+
An array or object with the result document of the :manual:`dropIndexes
37+
</reference/command/dropIndexes>` command. The return type will depend on the
38+
``typeMap`` option.
3839

3940
Example
4041
-------

docs/reference/method/MongoDBCollection-find.txt

Lines changed: 3 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -29,9 +29,10 @@ Definition
2929

3030
.. include:: /includes/apiargs/MongoDBCollection-method-find-option.rst
3131

32-
:returns:
32+
Return Values
33+
-------------
3334

34-
A :php:`MongoDB\\Driver\\Cursor <class.mongodb-driver-cursor>` object.
35+
A :php:`MongoDB\\Driver\\Cursor <class.mongodb-driver-cursor>` object.
3536

3637
Examples
3738
--------

docs/reference/method/MongoDBCollection-findOne.txt

Lines changed: 5 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -29,11 +29,12 @@ Definition
2929

3030
.. include:: /includes/apiargs/MongoDBCollection-method-findOne-option.rst
3131

32-
:returns:
32+
Return Values
33+
-------------
3334

34-
An array or object for the :term:`first document <natural order>` document
35-
that matched the query, or ``null`` if no document matched the query. The
36-
return type will depend on the ``typeMap`` option.
35+
An array or object for the :term:`first document <natural order>` document that
36+
matched the query, or ``null`` if no document matched the query. The return type
37+
will depend on the ``typeMap`` option.
3738

3839
Examples
3940
--------

docs/reference/method/MongoDBCollection-findOneAndDelete.txt

Lines changed: 4 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -31,10 +31,11 @@ Definition
3131

3232
.. include:: /includes/extracts/bson-deserialization-findOneAndDelete.rst
3333

34-
:returns:
34+
Return Values
35+
-------------
3536

36-
An object for the document that was deleted, or ``null`` if no document
37-
matched the query.
37+
An object for the document that was deleted, or ``null`` if no document matched
38+
the query.
3839

3940
Examples
4041
--------

docs/reference/method/MongoDBCollection-findOneAndReplace.txt

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -31,12 +31,12 @@ Definition
3131

3232
.. include:: /includes/extracts/bson-deserialization-findOneAndReplace.rst
3333

34-
:returns:
34+
Return Values
35+
-------------
3536

36-
An object for either the original or the replaced document, depending on
37-
the specified value of the ``returnDocument`` option. By default, the
38-
original document is returned. If no document matched the query, ``null``
39-
is returned.
37+
An object for either the original or the replaced document, depending on the
38+
specified value of the ``returnDocument`` option. By default, the original
39+
document is returned. If no document matched the query, ``null`` is returned.
4040

4141
Examples
4242
--------

docs/reference/method/MongoDBCollection-findOneAndUpdate.txt

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -31,12 +31,12 @@ Definition
3131

3232
.. include:: /includes/extracts/bson-deserialization-findOneAndUpdate.rst
3333

34-
:returns:
34+
Return Values
35+
-------------
3536

36-
An object for either the original or the updated document, depending on
37-
the specified value of the ``returnDocument`` option. By default, the
38-
original document is returned. If no document matched the query, ``null``
39-
is returned.
37+
An object for either the original or the updated document, depending on the
38+
specified value of the ``returnDocument`` option. By default, the original
39+
document is returned. If no document matched the query, ``null`` is returned.
4040

4141
Examples
4242
--------

docs/reference/method/MongoDBCollection-getCollectionName.txt

Lines changed: 3 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -21,9 +21,10 @@ Definition
2121

2222
function getCollectionName(): string
2323

24-
:returns:
24+
Return Values
25+
-------------
2526

26-
The name of this collection as a string.
27+
The name of this collection as a string.
2728

2829
Example
2930
-------

docs/reference/method/MongoDBCollection-getDatabaseName.txt

Lines changed: 3 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -21,9 +21,10 @@ Definition
2121

2222
function getDatabaseName(): string
2323

24-
:returns:
24+
Return Values
25+
-------------
2526

26-
The name of the database containing this collection as a string.
27+
The name of the database containing this collection as a string.
2728

2829
Example
2930
-------

docs/reference/method/MongoDBCollection-getManager.txt

Lines changed: 3 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -23,9 +23,10 @@ Definition
2323

2424
function getManager(): MongoDB\Manager
2525

26-
:returns:
26+
Return Values
27+
-------------
2728

28-
A :php:`MongoDB\\Driver\\Manager <class.mongodb-driver-manager>` object.
29+
A :php:`MongoDB\\Driver\\Manager <class.mongodb-driver-manager>` object.
2930

3031
See Also
3132
--------

docs/reference/method/MongoDBCollection-getNamespace.txt

Lines changed: 3 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -22,9 +22,10 @@ Definition
2222

2323
function getNamespace(): string
2424

25-
:returns:
25+
Return Values
26+
-------------
2627

27-
The namespace of this collection as a string.
28+
The namespace of this collection as a string.
2829

2930
Example
3031
-------

0 commit comments

Comments
 (0)