Skip to content

Update rst spec links to markdown #1741

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
wants to merge 1 commit into
base: v2.x
Choose a base branch
from
Open
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
6 changes: 3 additions & 3 deletions CONTRIBUTING.md
Original file line number Diff line number Diff line change
Expand Up @@ -58,21 +58,21 @@ The test suite references the following environment variables:
`username` URI option for clients constructed by the test suite, which will
override any credentials in the connection string itself.

The following environment variable is used for [stable API testing](https://github.com/mongodb/specifications/blob/master/source/versioned-api/tests/README.rst):
The following environment variable is used for [stable API testing](https://github.com/mongodb/specifications/blob/master/source/versioned-api/tests/README.md):

* `API_VERSION`: If defined, this value will be used to construct a
[`MongoDB\Driver\ServerApi`](https://www.php.net/manual/en/mongodb-driver-serverapi.construct.php),
which will then be specified as the `serverApi` driver option for clients
created by the test suite.

The following environment variables are used for [load balancer testing](https://github.com/mongodb/specifications/blob/master/source/load-balancers/tests/README.rst):
The following environment variables are used for [load balancer testing](https://github.com/mongodb/specifications/blob/master/source/load-balancers/tests/README.md):

* `MONGODB_SINGLE_MONGOS_LB_URI`: Connection string to a load balancer backed
by a single mongos host.
* `MONGODB_MULTI_MONGOS_LB_URI`: Connection string to a load balancer backed by
multiple mongos hosts.

The following environment variables are used for [CSFLE testing](https://github.com/mongodb/specifications/blob/master/source/client-side-encryption/tests/README.rst):
The following environment variables are used for [CSFLE testing](https://github.com/mongodb/specifications/blob/master/source/client-side-encryption/tests/README.md):

* `AWS_ACCESS_KEY_ID`
* `AWS_SECRET_ACCESS_KEY`
Expand Down
2 changes: 1 addition & 1 deletion benchmark/src/DriverBench/MultiDocBench.php
Original file line number Diff line number Diff line change
Expand Up @@ -20,7 +20,7 @@
final class MultiDocBench
{
/**
* @see https://github.com/mongodb/specifications/blob/master/source/benchmarking/benchmarking.rst#find-many-and-empty-the-cursor
* @see https://github.com/mongodb/specifications/blob/master/source/benchmarking/benchmarking.md#find-many-and-empty-the-cursor
* @param array{options: array} $params
*/
#[BeforeMethods('beforeFindMany')]
Expand Down
2 changes: 1 addition & 1 deletion src/ChangeStream.php
Original file line number Diff line number Diff line change
Expand Up @@ -173,7 +173,7 @@ public function __construct(private ChangeStreamIterator $iterator, callable $re
/**
* Determines if an exception is a resumable error.
*
* @see https://github.com/mongodb/specifications/blob/master/source/change-streams/change-streams.rst#resumable-error
* @see https://github.com/mongodb/specifications/blob/master/source/change-streams/change-streams.md#resumable-error
*/
private function isResumableError(RuntimeException $exception): bool
{
Expand Down
2 changes: 1 addition & 1 deletion src/Database.php
Original file line number Diff line number Diff line change
Expand Up @@ -268,7 +268,7 @@ public function command(array|object $command, array $options = []): CursorInter
* collection.
*
* @see CreateCollection::__construct() for supported options
* @see https://github.com/mongodb/specifications/blob/master/source/client-side-encryption/client-side-encryption.rst#create-collection-helper
* @see https://github.com/mongodb/specifications/blob/master/source/client-side-encryption/client-side-encryption.md#create-collection-helper
* @see https://www.mongodb.com/docs/manual/core/queryable-encryption/fundamentals/manage-collections/
* @throws UnsupportedException if options are not supported by the selected server
* @throws InvalidArgumentException for parameter/option parsing errors
Expand Down
2 changes: 1 addition & 1 deletion src/Model/ChangeStreamIterator.php
Original file line number Diff line number Diff line change
Expand Up @@ -270,7 +270,7 @@ private function isAtEndOfBatch(): bool
/**
* Perform housekeeping after an iteration event.
*
* @see https://github.com/mongodb/specifications/blob/master/source/change-streams/change-streams.rst#updating-the-cached-resume-token
* @see https://github.com/mongodb/specifications/blob/master/source/change-streams/change-streams.md#updating-the-cached-resume-token
*/
private function onIteration(bool $incrementBatchPosition): void
{
Expand Down
2 changes: 1 addition & 1 deletion src/Model/CollectionInfo.php
Original file line number Diff line number Diff line change
Expand Up @@ -30,7 +30,7 @@
* collection. It provides methods to access options for the collection.
*
* @see \MongoDB\Database::listCollections()
* @see https://github.com/mongodb/specifications/blob/master/source/enumerate-collections.rst
* @see https://github.com/mongodb/specifications/blob/master/source/enumerate-collections.md
* @template-implements ArrayAccess<string, mixed>
*/
class CollectionInfo implements ArrayAccess
Expand Down
4 changes: 2 additions & 2 deletions src/Model/IndexInfo.php
Original file line number Diff line number Diff line change
Expand Up @@ -34,7 +34,7 @@
* db.collection.createIndex() documentation.
*
* @see \MongoDB\Collection::listIndexes()
* @see https://github.com/mongodb/specifications/blob/master/source/enumerate-indexes.rst
* @see https://github.com/mongodb/specifications/blob/master/source/enumerate-indexes.md
* @see https://mongodb.com/docs/manual/reference/method/db.collection.createIndex/
* @template-implements ArrayAccess<string, mixed>
*/
Expand Down Expand Up @@ -152,7 +152,7 @@ public function offsetExists(mixed $offset): bool
* also be used to access fields that do not have a helper method.
*
* @see https://php.net/arrayaccess.offsetget
* @see https://github.com/mongodb/specifications/blob/master/source/enumerate-indexes.rst#getting-full-index-information
* @see https://github.com/mongodb/specifications/blob/master/source/enumerate-indexes.md#getting-full-index-information
* @psalm-param array-key $offset
*/
public function offsetGet(mixed $offset): mixed
Expand Down
2 changes: 1 addition & 1 deletion src/Model/IndexInput.php
Original file line number Diff line number Diff line change
Expand Up @@ -35,7 +35,7 @@
*
* @internal
* @see \MongoDB\Collection::createIndexes()
* @see https://github.com/mongodb/specifications/blob/master/source/enumerate-indexes.rst
* @see https://github.com/mongodb/specifications/blob/master/source/enumerate-indexes.md
* @see https://mongodb.com/docs/manual/reference/method/db.collection.createIndex/
*/
final class IndexInput implements Serializable
Expand Down
2 changes: 1 addition & 1 deletion src/Model/SearchIndexInput.php
Original file line number Diff line number Diff line change
Expand Up @@ -31,7 +31,7 @@
*
* @internal
* @see \MongoDB\Collection::createSearchIndexes()
* @see https://github.com/mongodb/specifications/blob/master/source/index-management/index-management.rst#search-indexes
* @see https://github.com/mongodb/specifications/blob/master/source/index-management/index-management.md#search-indexes
* @see https://mongodb.com/docs/manual/reference/method/db.collection.createSearchIndex/
*/
final class SearchIndexInput implements Serializable
Expand Down
2 changes: 1 addition & 1 deletion src/Operation/CountDocuments.php
Original file line number Diff line number Diff line change
Expand Up @@ -35,7 +35,7 @@
* Operation for obtaining an exact count of documents in a collection
*
* @see \MongoDB\Collection::countDocuments()
* @see https://github.com/mongodb/specifications/blob/master/source/crud/crud.rst#countdocuments
* @see https://github.com/mongodb/specifications/blob/master/source/crud/crud.md#countdocuments
*/
final class CountDocuments
{
Expand Down
4 changes: 2 additions & 2 deletions src/Operation/CreateEncryptedCollection.php
Original file line number Diff line number Diff line change
Expand Up @@ -44,8 +44,8 @@
* @internal
* @see \MongoDB\Database::createCollection()
* @see \MongoDB\Database::createEncryptedCollection()
* @see https://github.com/mongodb/specifications/blob/master/source/client-side-encryption/client-side-encryption.rst#create-collection-helper
* @see https://github.com/mongodb/specifications/blob/master/source/client-side-encryption/client-side-encryption.rst#create-encrypted-collection-helper
* @see https://github.com/mongodb/specifications/blob/master/source/client-side-encryption/client-side-encryption.md#create-collection-helper
* @see https://github.com/mongodb/specifications/blob/master/source/client-side-encryption/client-side-encryption.md#create-encrypted-collection-helper
* @see https://www.mongodb.com/docs/manual/core/queryable-encryption/fundamentals/manage-collections/
*/
final class CreateEncryptedCollection
Expand Down
2 changes: 1 addition & 1 deletion src/Operation/DropEncryptedCollection.php
Original file line number Diff line number Diff line change
Expand Up @@ -34,7 +34,7 @@
* @internal
* @see \MongoDB\Database::dropCollection()
* @see \MongoDB\Collection::drop()
* @see https://github.com/mongodb/specifications/blob/master/source/client-side-encryption/client-side-encryption.rst#drop-collection-helper
* @see https://github.com/mongodb/specifications/blob/master/source/client-side-encryption/client-side-encryption.md#drop-collection-helper
* @see https://www.mongodb.com/docs/manual/core/queryable-encryption/fundamentals/manage-collections/
*/
final class DropEncryptedCollection
Expand Down
6 changes: 3 additions & 3 deletions src/Operation/Watch.php
Original file line number Diff line number Diff line change
Expand Up @@ -364,7 +364,7 @@ private function executeAggregate(Server $server): CursorInterface
/**
* Return the initial resume token for creating the ChangeStreamIterator.
*
* @see https://github.com/mongodb/specifications/blob/master/source/change-streams/change-streams.rst#updating-the-cached-resume-token
* @see https://github.com/mongodb/specifications/blob/master/source/change-streams/change-streams.md#updating-the-cached-resume-token
*/
private function getInitialResumeToken(): array|object|null
{
Expand All @@ -386,7 +386,7 @@ private function getInitialResumeToken(): array|object|null
/**
* Resumes a change stream.
*
* @see https://github.com/mongodb/specifications/blob/master/source/change-streams/change-streams.rst#resume-process
* @see https://github.com/mongodb/specifications/blob/master/source/change-streams/change-streams.md#resume-process
* @throws InvalidArgumentException
*/
private function resume(array|object|null $resumeToken = null, bool $hasAdvanced = false): ChangeStreamIterator
Expand Down Expand Up @@ -422,7 +422,7 @@ private function resume(array|object|null $resumeToken = null, bool $hasAdvanced
/**
* Determine whether to capture operation time from an aggregate response.
*
* @see https://github.com/mongodb/specifications/blob/master/source/change-streams/change-streams.rst#startatoperationtime
* @see https://github.com/mongodb/specifications/blob/master/source/change-streams/change-streams.md#startatoperationtime
*/
private function shouldCaptureOperationTime(): bool
{
Expand Down
6 changes: 3 additions & 3 deletions src/functions.php
Original file line number Diff line number Diff line change
Expand Up @@ -178,7 +178,7 @@ function document_to_array(array|object $document): array
* autoEncryption driver option (if available).
*
* @internal
* @see https://github.com/mongodb/specifications/blob/master/source/client-side-encryption/client-side-encryption.rst#collection-encryptedfields-lookup-getencryptedfields
* @see https://github.com/mongodb/specifications/blob/master/source/client-side-encryption/client-side-encryption.md#collection-encryptedfields-lookup-getencryptedfields
* @see Collection::drop()
* @see Database::createCollection()
* @see Database::dropCollection()
Expand All @@ -194,7 +194,7 @@ function get_encrypted_fields_from_driver(string $databaseName, string $collecti
* Return a collection's encryptedFields option from the server (if any).
*
* @internal
* @see https://github.com/mongodb/specifications/blob/master/source/client-side-encryption/client-side-encryption.rst#collection-encryptedfields-lookup-getencryptedfields
* @see https://github.com/mongodb/specifications/blob/master/source/client-side-encryption/client-side-encryption.md#collection-encryptedfields-lookup-getencryptedfields
* @see Collection::drop()
* @see Database::dropCollection()
*/
Expand Down Expand Up @@ -611,7 +611,7 @@ function select_server(Manager $manager, array $options): Server
* must be forced due to the existence of pre-5.0 servers in the topology.
*
* @internal
* @see https://github.com/mongodb/specifications/blob/master/source/crud/crud.rst#aggregation-pipelines-with-write-stages
* @see https://github.com/mongodb/specifications/blob/master/source/crud/crud.md#aggregation-pipelines-with-write-stages
*/
function select_server_for_aggregate_write_stage(Manager $manager, array &$options): Server
{
Expand Down
Loading