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
--------

0 commit comments

Comments
 (0)