Skip to content

Commit 3026b3c

Browse files
committed
Use generic language for documenting method params
1 parent c0e0ebc commit 3026b3c

File tree

52 files changed

+52
-70
lines changed

Some content is hidden

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

52 files changed

+52
-70
lines changed

docs/reference/method/MongoDBClient-dropDatabase.txt

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -21,7 +21,7 @@ Definition
2121

2222
function dropDatabase($databaseName, array $options []): array|object
2323

24-
:phpmethod:`MongoDB\\Client::dropDatabase()` has the following parameters:
24+
This method has the following parameters:
2525

2626
.. include:: /includes/apiargs/MongoDBClient-method-dropDatabase-param.rst
2727

docs/reference/method/MongoDBClient-listDatabases.txt

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -21,7 +21,7 @@ Definition
2121

2222
function listDatabases(array $options = []): MongoDB\Model\DatabaseInfoIterator
2323

24-
:phpmethod:`MongoDB\\Client::listDatabases()` has the following parameters:
24+
This method has the following parameters:
2525

2626
.. include:: /includes/apiargs/MongoDBClient-method-listDatabases-param.rst
2727

docs/reference/method/MongoDBClient-selectCollection.txt

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -21,7 +21,7 @@ Definition
2121

2222
function selectCollection($databaseName, $collectionName, array $options = []): MongoDB\Collection
2323

24-
:phpmethod:`MongoDB\\Client::selectCollection()` has the following parameters:
24+
This method has the following parameters:
2525

2626
.. include:: /includes/apiargs/MongoDBClient-method-selectCollection-param.rst
2727

docs/reference/method/MongoDBClient-selectDatabase.txt

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -21,7 +21,7 @@ Definition
2121

2222
function selectDatabase($databaseName, array $options = []): MongoDB\Database
2323

24-
:phpmethod:`MongoDB\\Client::selectDatabase()` has the following parameters:
24+
This method has the following parameters:
2525

2626
.. include:: /includes/apiargs/MongoDBClient-method-selectDatabase-param.rst
2727

docs/reference/method/MongoDBClient__construct.txt

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -21,7 +21,7 @@ Definition
2121

2222
function __construct($uri = 'mongodb://127.0.0.1/', array $uriOptions = [], array $driverOptions = [])
2323

24-
:phpmethod:`MongoDB\\Client::__construct()` has the following parameters:
24+
This constructor has the following parameters:
2525

2626
.. include:: /includes/apiargs/MongoDBClient-method-construct-param.rst
2727

docs/reference/method/MongoDBClient__get.txt

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -23,7 +23,7 @@ Definition
2323

2424
function __get($databaseName): MongoDB\Database
2525

26-
:phpmethod:`MongoDB\\Client::__get()` has the following parameters:
26+
This method has the following parameters:
2727

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

docs/reference/method/MongoDBCollection-aggregate.txt

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -22,7 +22,7 @@ Definition
2222

2323
function aggregate(array $pipeline, array $options = []): Traversable
2424

25-
:phpmethod:`MongoDB\\Collection::aggregate()` has the following parameters:
25+
This method has the following parameters:
2626

2727
.. include:: /includes/apiargs/MongoDBCollection-method-aggregate-param.rst
2828

docs/reference/method/MongoDBCollection-bulkWrite.txt

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -21,7 +21,7 @@ Definition
2121

2222
function bulkWrite(array $operations, array $options = []): MongoDB\BulkWriteResult
2323

24-
:phpmethod:`MongoDB\\Collection::bulkWrite()` has the following parameters:
24+
This method has the following parameters:
2525

2626
.. include:: /includes/apiargs/MongoDBCollection-method-bulkWrite-param.rst
2727

docs/reference/method/MongoDBCollection-count.txt

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -21,7 +21,7 @@ Definition
2121

2222
function count($filter = [], array $options = []): integer
2323

24-
:phpmethod:`MongoDB\\Collection::count()` has the following parameters:
24+
This method has the following parameters:
2525

2626
.. include:: /includes/apiargs/MongoDBCollection-method-count-param.rst
2727

docs/reference/method/MongoDBCollection-createIndex.txt

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -21,7 +21,7 @@ Definition
2121

2222
function createIndex($key, array $options = []): string
2323

24-
:phpmethod:`MongoDB\\Collection::createIndex()` has the following parameters:
24+
This method has the following parameters:
2525

2626
.. include:: /includes/apiargs/MongoDBCollection-method-createIndex-param.rst
2727

docs/reference/method/MongoDBCollection-createIndexes.txt

Lines changed: 1 addition & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -21,8 +21,7 @@ Definition
2121

2222
function createIndexes(array $indexes, array $options = []): string[]
2323

24-
:phpmethod:`MongoDB\\Collection::createIndexes()` has the following
25-
parameters:
24+
This method has the following parameters:
2625

2726
.. include:: /includes/apiargs/MongoDBCollection-method-createIndexes-param.rst
2827

docs/reference/method/MongoDBCollection-deleteMany.txt

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -21,7 +21,7 @@ Definition
2121

2222
function deleteMany($filter, array $options = []): MongoDB\DeleteResult
2323

24-
:phpmethod:`MongoDB\\Collection::deleteMany()` has the following parameters:
24+
This method has the following parameters:
2525

2626
.. include:: /includes/apiargs/MongoDBCollection-method-deleteMany-param.rst
2727

docs/reference/method/MongoDBCollection-deleteOne.txt

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -23,7 +23,7 @@ Definition
2323

2424
function deleteOne($filter, array $options = []): MongoDB\DeleteResult
2525

26-
:phpmethod:`MongoDB\\Collection::deleteOne()` has the following parameters:
26+
This method has the following parameters:
2727

2828
.. include:: /includes/apiargs/MongoDBCollection-method-deleteOne-param.rst
2929

docs/reference/method/MongoDBCollection-distinct.txt

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -21,7 +21,7 @@ Definition
2121

2222
function distinct($fieldName, $filter = [], array $options = []): mixed[]
2323

24-
:phpmethod:`MongoDB\\Collection::distinct()` has the following parameters:
24+
This method has the following parameters:
2525

2626
.. include:: /includes/apiargs/MongoDBCollection-method-distinct-param.rst
2727

docs/reference/method/MongoDBCollection-drop.txt

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -21,7 +21,7 @@ Definition
2121

2222
function drop(array $options = []): array|object
2323

24-
:phpmethod:`MongoDB\\Collection::drop()` has the following parameters:
24+
This method has the following parameters:
2525

2626
.. include:: /includes/apiargs/MongoDBCollection-method-drop-param.rst
2727

docs/reference/method/MongoDBCollection-dropIndex.txt

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -21,7 +21,7 @@ Definition
2121

2222
function dropIndex($indexName, array $options = []): array|object
2323

24-
:phpmethod:`MongoDB\\Collection::dropIndex()` has the following parameters:
24+
This method has the following parameters:
2525

2626
.. include:: /includes/apiargs/MongoDBCollection-method-dropIndex-param.rst
2727

docs/reference/method/MongoDBCollection-dropIndexes.txt

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -22,7 +22,7 @@ Definition
2222

2323
function dropIndexes(array $options = []): array|object
2424

25-
:phpmethod:`MongoDB\\Collection::dropIndexes()` has the following parameters:
25+
This method has the following parameters:
2626

2727
.. include:: /includes/apiargs/MongoDBCollection-method-dropIndex-param.rst
2828

docs/reference/method/MongoDBCollection-find.txt

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -21,7 +21,7 @@ Definition
2121

2222
function find($filter = [], array $options = []): MongoDB\Driver\Cursor
2323

24-
:phpmethod:`MongoDB\\Collection::find()` has the following parameters:
24+
This method has the following parameters:
2525

2626
.. include:: /includes/apiargs/MongoDBCollection-method-find-param.rst
2727

docs/reference/method/MongoDBCollection-findOne.txt

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -21,7 +21,7 @@ Definition
2121

2222
function findOne($filter = [], array $options = []): array|object|null
2323

24-
:phpmethod:`MongoDB\\Collection::findOne()` has the following parameters:
24+
This method has the following parameters:
2525

2626
.. include:: /includes/apiargs/MongoDBCollection-method-findOne-param.rst
2727

docs/reference/method/MongoDBCollection-findOneAndDelete.txt

Lines changed: 1 addition & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -21,8 +21,7 @@ Definition
2121

2222
function findOneAndDelete($filter = [], array $options = []): object|null
2323

24-
:phpmethod:`MongoDB\\Collection::findOneAndDelete()` has the following
25-
parameters:
24+
This method has the following parameters:
2625

2726
.. include:: /includes/apiargs/MongoDBCollection-method-findOneAndDelete-param.rst
2827

docs/reference/method/MongoDBCollection-findOneAndReplace.txt

Lines changed: 1 addition & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -21,8 +21,7 @@ Definition
2121

2222
function findOneAndReplace($filter, $replacement, array $options = []): object|null
2323

24-
:phpmethod:`MongoDB\\Collection::findOneAndReplace()` has the following
25-
parameters:
24+
This method has the following parameters:
2625

2726
.. include:: /includes/apiargs/MongoDBCollection-method-findOneAndReplace-param.rst
2827

docs/reference/method/MongoDBCollection-findOneAndUpdate.txt

Lines changed: 1 addition & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -21,8 +21,7 @@ Definition
2121

2222
function findOneAndUpdate($filter, $update, array $options = []): object|null
2323

24-
:phpmethod:`MongoDB\\Collection::findOneAndUpdate()` has the following
25-
parameters:
24+
This method has the following parameters:
2625

2726
.. include:: /includes/apiargs/MongoDBCollection-method-findOneAndUpdate-param.rst
2827

docs/reference/method/MongoDBCollection-insertMany.txt

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -21,7 +21,7 @@ Definition
2121

2222
function insertMany(array $documents, array $options = []): MongoDB\InsertManyResult
2323

24-
:phpmethod:`MongoDB\\Collection::insertMany()` has the following parameters:
24+
This method has the following parameters:
2525

2626
.. include:: /includes/apiargs/MongoDBCollection-method-insertMany-param.rst
2727

docs/reference/method/MongoDBCollection-insertOne.txt

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -21,7 +21,7 @@ Definition
2121

2222
function insertOne($document, array $options = []): MongoDB\InsertOneResult
2323

24-
:phpmethod:`MongoDB\\Collection::insertOne()` has the following parameters:
24+
This method has the following parameters:
2525

2626
.. include:: /includes/apiargs/MongoDBCollection-method-insertOne-param.rst
2727

docs/reference/method/MongoDBCollection-listIndexes.txt

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -21,7 +21,7 @@ Definition
2121

2222
function listIndexes(array $options = []): MongoDB\Model\IndexInfoIterator
2323

24-
:phpmethod:`MongoDB\\Collection::listIndexes()` has the following parameters:
24+
This method has the following parameters:
2525

2626
.. include:: /includes/apiargs/MongoDBCollection-method-listIndexes-param.rst
2727

docs/reference/method/MongoDBCollection-replaceOne.txt

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -23,7 +23,7 @@ Definition
2323

2424
function replaceOne($filter, $replacement, array $options = []): MongoDB\UpdateResult
2525

26-
:phpmethod:`MongoDB\\Collection::replaceOne()` has the following parameters:
26+
This method has the following parameters:
2727

2828
.. include:: /includes/apiargs/MongoDBCollection-method-replaceOne-param.rst
2929

docs/reference/method/MongoDBCollection-updateMany.txt

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -21,7 +21,7 @@ Definition
2121

2222
function updateMany($filter, $update, array $options = []): MongoDB\UpdateResult
2323

24-
:phpmethod:`MongoDB\\Collection::updateMany()` has the following parameters:
24+
This method has the following parameters:
2525

2626
.. include:: /includes/apiargs/MongoDBCollection-method-updateMany-param.rst
2727

docs/reference/method/MongoDBCollection-updateOne.txt

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -23,7 +23,7 @@ Definition
2323

2424
function updateOne($filter, $update, array $options = []): MongoDB\UpdateResult
2525

26-
:phpmethod:`MongoDB\\Collection::updateOne()` has the following parameters:
26+
This method has the following parameters:
2727

2828
.. include:: /includes/apiargs/MongoDBCollection-method-updateOne-param.rst
2929

docs/reference/method/MongoDBCollection-withOptions.txt

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -21,7 +21,7 @@ Definition
2121

2222
function withOptions(array $options = []): MongoDB\Collection
2323

24-
:phpmethod:`MongoDB\\Collection::withOptions()` has the following parameters:
24+
This method has the following parameters:
2525

2626
.. include:: /includes/apiargs/MongoDBCollection-method-withOptions-param.rst
2727

docs/reference/method/MongoDBCollection__construct.txt

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -21,7 +21,7 @@ Definition
2121

2222
function __construct(MongoDB\Driver\Manager $manager, $databaseName, $collectionName, array $options = [])
2323

24-
:phpmethod:`MongoDB\\Collection::__construct` has the following parameters:
24+
This constructor has the following parameters:
2525

2626
.. include:: /includes/apiargs/MongoDBCollection-method-construct-param.rst
2727

docs/reference/method/MongoDBDatabase-command.txt

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -21,7 +21,7 @@ Definition
2121

2222
function command($command, array $options = []): MongoDB\Driver\Cursor
2323

24-
:phpmethod:`MongoDB\\Database::command()` has the following parameters:
24+
This method has the following parameters:
2525

2626
.. include:: /includes/apiargs/MongoDBDatabase-method-command-param.rst
2727

docs/reference/method/MongoDBDatabase-createCollection.txt

Lines changed: 1 addition & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -33,8 +33,7 @@ Definition
3333
:manual:`document validation criteria </core/document-validation>`,
3434
or configure your storage engine or indexing options.
3535

36-
:phpmethod:`MongoDB\\Database::createCollection()` has the following
37-
parameters:
36+
This method has the following parameters:
3837

3938
.. include:: /includes/apiargs/MongoDBDatabase-method-createCollection-param.rst
4039

docs/reference/method/MongoDBDatabase-drop.txt

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -21,7 +21,7 @@ Definition
2121

2222
function drop(array $options = []): array|object
2323

24-
:phpmethod:`MongoDB\\Database::drop()` has the following parameters:
24+
This method has the following parameters:
2525

2626
.. include:: /includes/apiargs/MongoDBDatabase-method-drop-param.rst
2727

docs/reference/method/MongoDBDatabase-dropCollection.txt

Lines changed: 1 addition & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -21,8 +21,7 @@ Definition
2121

2222
function dropCollection($collectionName, array $options = []): array|object
2323

24-
:phpmethod:`MongoDB\\Database::dropCollection()` has the following
25-
parameters:
24+
This method has the following parameters:
2625

2726
.. include:: /includes/apiargs/MongoDBDatabase-method-dropCollection-param.rst
2827

docs/reference/method/MongoDBDatabase-listCollections.txt

Lines changed: 1 addition & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -21,8 +21,7 @@ Definition
2121

2222
function listCollections(array $options = []): MongoDB\Model\CollectionInfoIterator
2323

24-
:phpmethod:`MongoDB\\Database::listCollections()` has the following
25-
parameters:
24+
This method has the following parameters:
2625

2726
.. include:: /includes/apiargs/MongoDBDatabase-method-listCollections-param.rst
2827

docs/reference/method/MongoDBDatabase-selectCollection.txt

Lines changed: 1 addition & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -21,8 +21,7 @@ Definition
2121

2222
function selectCollection($collectionName, array $options = []): MongoDB\Collection
2323

24-
:phpmethod:`MongoDB\\Database::selectCollection()` has the following
25-
parameters:
24+
This method has the following parameters:
2625

2726
.. include:: /includes/apiargs/MongoDBDatabase-method-selectCollection-param.rst
2827

docs/reference/method/MongoDBDatabase-selectGridFSBucket.txt

Lines changed: 1 addition & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -21,8 +21,7 @@ Definition
2121

2222
function selectGridFSBucket(array $options = []): MongoDB\GridFS\Bucket
2323

24-
:phpmethod:`MongoDB\\Database::selectGridFSBucket()` has the following
25-
parameters:
24+
This method has the following parameters:
2625

2726
.. include:: /includes/apiargs/MongoDBDatabase-method-selectGridFSBucket-param.rst
2827

docs/reference/method/MongoDBDatabase-withOptions.txt

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -21,7 +21,7 @@ Definition
2121

2222
function withOptions(array $options = []): MongoDB\Database
2323

24-
:phpmethod:`MongoDB\\Database::withOptions()` has the following parameters:
24+
This method has the following parameters:
2525

2626
.. include:: /includes/apiargs/MongoDBDatabase-method-withOptions-param.rst
2727

docs/reference/method/MongoDBDatabase__construct.txt

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -21,7 +21,7 @@ Definition
2121

2222
function __construct(MongoDB\Driver\Manager $manager, $databaseName, array $options = [])
2323

24-
:phpmethod:`MongoDB\\Database::__construct` has the following parameters:
24+
This constructor has the following parameters:
2525

2626
.. include:: /includes/apiargs/MongoDBDatabase-method-construct-param.rst
2727

docs/reference/method/MongoDBDatabase__get.txt

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -21,7 +21,7 @@ Definition
2121

2222
function __get($collectionName): MongoDB\Collection
2323

24-
:phpmethod:`MongoDB\\Database::__get()` has the following parameters:
24+
This method has the following parameters:
2525

2626
.. include:: /includes/apiargs/MongoDBDatabase-method-get-param.rst
2727

docs/reference/method/MongoDBGridFSBucket-delete.txt

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -21,7 +21,7 @@ Definition
2121

2222
function delete($id): void
2323

24-
:phpmethod:`MongoDB\\GridFS\\Bucket::delete()` has the following parameters:
24+
This method has the following parameters:
2525

2626
.. include:: /includes/apiargs/MongoDBGridFSBucket-method-delete-param.rst
2727

docs/reference/method/MongoDBGridFSBucket-downloadToStream.txt

Lines changed: 1 addition & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -22,8 +22,7 @@ Definition
2222

2323
function downloadToStream($id, $destination): void
2424

25-
:phpmethod:`MongoDB\\GridFS\\Bucket::downloadToStream()` has the following
26-
parameters:
25+
This method has the following parameters:
2726

2827
.. include:: /includes/apiargs/MongoDBGridFSBucket-method-downloadToStream-param.rst
2928

docs/reference/method/MongoDBGridFSBucket-downloadToStreamByName.txt

Lines changed: 1 addition & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -22,8 +22,7 @@ Definition
2222

2323
function downloadToStreamByName($filename, $destination, array $options = []): void
2424

25-
:phpmethod:`MongoDB\\GridFS\\Bucket::downloadToStreamByName()` has the
26-
following parameters:
25+
This method has the following parameters:
2726

2827
.. include:: /includes/apiargs/MongoDBGridFSBucket-method-downloadToStreamByName-param.rst
2928

0 commit comments

Comments
 (0)