Fix mdformat check (#1790)

Author: blink1073

.pre-commit-config.yaml

@@ -23,7 +23,7 @@ repos:
       stages: [manual]
 
 - repo: https://github.com/executablebooks/mdformat
-  rev: 0.7.18
+  rev: 0.7.22
   hooks:
     - id: mdformat
       args: ["--wrap=120", "--number"]
@@ -32,7 +32,7 @@ repos:
         - mdformat-frontmatter
         - mdformat-gfm
         - mdformat-gfm-alerts
-        - mdformat-mkdocs~=3.0
+        - mdformat-mkdocs
 
 - repo: local
   hooks:
@@ -55,7 +55,7 @@ repos:
   rev: v3.12.2
   hooks:
     - id: markdown-link-check
-      args: ["-c", "markdown_link_config.json"]
+      args: ["-q", "-c", "markdown_link_config.json"]
 
 - repo: https://github.com/rstcheck/rstcheck
   rev: v6.2.0

source/auth/auth.md

@@ -922,18 +922,18 @@ else // the valid host string contains no periods and is not "aws.amazonaws.com"
 
 Examples are provided below.
 
-| Host                           | Region     | Notes                                            |
-| ------------------------------ | ---------- | ------------------------------------------------ |
-| sts.amazonaws.com              | us-east-1  | the host is "sts.amazonaws.com"; use `us-east-1` |
-| sts.us-west-2.amazonaws.com    | us-west-2  | use the second label                             |
-| sts.us-west-2.amazonaws.com.ch | us-west-2  | use the second label                             |
-| example.com                    | com        | use the second label                             |
-| localhost                      | us-east-1  | no "`.`" character; use the default region       |
-| sts..com                       | \< Error > | second label is empty                            |
-| .amazonaws.com                 | \< Error > | starts with a period                             |
-| sts.amazonaws.                 | \< Error > | ends with a period                               |
-| ""                             | \< Error > | empty string                                     |
-| "string longer than 255"       | \< Error > | string longer than 255 bytes                     |
+| Host                           | Region    | Notes                                            |
+| ------------------------------ | --------- | ------------------------------------------------ |
+| sts.amazonaws.com              | us-east-1 | the host is "sts.amazonaws.com"; use `us-east-1` |
+| sts.us-west-2.amazonaws.com    | us-west-2 | use the second label                             |
+| sts.us-west-2.amazonaws.com.ch | us-west-2 | use the second label                             |
+| example.com                    | com       | use the second label                             |
+| localhost                      | us-east-1 | no "`.`" character; use the default region       |
+| sts..com                       | < Error > | second label is empty                            |
+| .amazonaws.com                 | < Error > | starts with a period                             |
+| sts.amazonaws.                 | < Error > | ends with a period                               |
+| ""                             | < Error > | empty string                                     |
+| "string longer than 255"       | < Error > | string longer than 255 bytes                     |
 
 #### [MongoCredential](#mongocredential) Properties
 

source/benchmarking/benchmarking.md

@@ -78,9 +78,9 @@ struct {
 | ------------------ | ------------------------------------------------------------------- |
 | **Name**           | **Description**                                                     |
 | subtype            | Type of blob format and encryption algorithm used.                  |
-| key_uuid\[16\]     | The value of \_id for the key used to decrypt the ciphertext.       |
+| key_uuid[16]       | The value of \_id for the key used to decrypt the ciphertext.       |
 | original_bson_type | The byte representing the original BSON type of the encrypted data. |
-| ciphertext\[\]     | The encrypted ciphertext (includes IV prepended).                   |
+| ciphertext[]       | The encrypted ciphertext (includes IV prepended).                   |
 
 ## Test Plan
 

source/bson-binary-encrypted/binary-encrypted.md

@@ -35,10 +35,10 @@ Each vector can take one of multiple data types (dtypes). The following table li
 | ---------------- | ---------- | ----------------------- | ----------------------------------------------------------------------------------------- |
 | `0x03`           | INT8       | 8                       | INT8                                                                                      |
 | `0x27`           | FLOAT32    | 32                      | FLOAT                                                                                     |
-| `0x10`           | PACKED_BIT | 1     `*`               | BOOL                                                                                      |
+| `0x10`           | PACKED_BIT | 1 `*`                   | BOOL                                                                                      |
 
 `*` A Binary Quantized (PACKED_BIT) Vector is a vector of 0s and 1s (bits), but it is represented in memory as a list of
-integers in \[0, 255\]. So, for example, the vector `[0, 255]` would be shorthand for the 16-bit vector
+integers in [0, 255]. So, for example, the vector `[0, 255]` would be shorthand for the 16-bit vector
 `[0,0,0,0,0,0,0,0,1,1,1,1,1,1,1,1]`. The idea is that each number (a uint8) can be stored as a single byte. Of course,
 some languages, Python for one, do not have an uint8 type, so must be represented as an int in memory, but not on disk.
 
@@ -182,8 +182,8 @@ End Function
 
 Drivers MUST validate vector metadata and raise an error if any invariant is violated:
 
-- Padding MUST be 0 for all dtypes where padding doesn’t apply, and MUST be within \[0, 7\] for PACKED_BIT.
-- A PACKED_BIT vector MUST NOT be empty if padding is in the range \[1, 7\].
+- Padding MUST be 0 for all dtypes where padding doesn’t apply, and MUST be within [0, 7] for PACKED_BIT.
+- A PACKED_BIT vector MUST NOT be empty if padding is in the range [1, 7].
 - For a PACKED_BIT vector, ignored bits must be zero.
 - When unpacking binary data into a FLOAT32 Vector structure, the length of the binary data following the dtype and
     padding MUST be a multiple of 4 bytes.

source/bson-binary-vector/bson-binary-vector.md

@@ -56,7 +56,7 @@ Each YAML file has the following keys:
 The definition of MATCH or MATCHES in the Spec Test Runner is as follows:
 
 - MATCH takes two values, `expected` and `actual`
-- Notation is "Assert \[actual\] MATCHES \[expected\]
+- Notation is "Assert [actual] MATCHES [expected]
 - Assertion passes if `expected` is a subset of `actual`, with the value `42` acting as placeholders for "any value"
 
 Pseudocode implementation of `actual` MATCHES `expected`:
@@ -167,7 +167,7 @@ and sharded clusters unless otherwise specified:
 
 1. `ChangeStream` must continuously track the last seen `resumeToken`
 
-2. `ChangeStream` will throw an exception if the server response is missing the resume token (if wire version is \< 8,
+2. `ChangeStream` will throw an exception if the server response is missing the resume token (if wire version is < 8,
     this is a driver-side error; for 8+, this is a server-side error)
 
 3. After receiving a `resumeToken`, `ChangeStream` will automatically resume one time on a resumable error with the

source/change-streams/tests/README.md

@@ -317,7 +317,7 @@ mongocryptd is released alongside the server. mongocryptd is available in versio
 Drivers MUST run all tests with mongocryptd on at least one platform for all tested server versions.
 
 Drivers MUST run all tests with [crypt_shared](../client-side-encryption.md#crypt_shared) on at least one platform for
-all tested server versions. For server versions \< 6.0, drivers MUST test with the latest major release of
+all tested server versions. For server versions < 6.0, drivers MUST test with the latest major release of
 [crypt_shared](../client-side-encryption.md#crypt_shared). Using the latest major release of
 [crypt_shared](../client-side-encryption.md#crypt_shared) is supported with older server versions.
 

source/client-side-encryption/tests/README.md

@@ -12,7 +12,7 @@ and sorting on language strings in a locale-aware fashion.
 
 A driver MUST support a Collation option for each of the relevant operations in server versions >= 3.4 (maxWireVersion
 5\) and MUST throw an error if a user supplies a Collation option for the operation and the selected server has
-maxWireVersion \< 5 or if the user is using opcode-based unacknowledged writes.
+maxWireVersion < 5 or if the user is using opcode-based unacknowledged writes.
 
 The CRUD and Index Management specs include the collation option in descriptions of API elements where it is supported.
 This document provides more details on the specific driver behavior required to handle the collation option.
@@ -43,7 +43,7 @@ gains.
 Server versions earlier than 3.4 don't always throw an error if an unknown option is supplied to certain operations.
 Because a Collation defines how documents are matched and sorted for both read and write operations, behavior
 differences between server versions are significant. Drivers therefore MUST throw an error if a user specifies a
-Collation and the selected server has a maxWireVersion \< 5 or if using opcode-based unacknowledged writes.
+Collation and the selected server has a maxWireVersion < 5 or if using opcode-based unacknowledged writes.
 
 ## Specification
 
@@ -140,7 +140,7 @@ hinting an index. See the [Index Management specification](../index-management/i
 ### Require maxWireVersion 5
 
 Drivers MUST require the server's maxWireVersion >= 5 to support Collations. When a collation is explicitly specified
-for a server with maxWireVersion \< 5, the driver MUST raise an error.
+for a server with maxWireVersion < 5, the driver MUST raise an error.
 
 ### Opcode-based Unacknowledged Writes
 
@@ -160,7 +160,7 @@ db.command({
 
 ### BulkWrite API
 
-If maxWireVersion \< 5, the driver MUST inspect each BulkWrite operation model for a collation and MUST raise an error
+If maxWireVersion < 5, the driver MUST inspect each BulkWrite operation model for a collation and MUST raise an error
 and MUST NOT send any operations to the server if a collation is explicitly specified on an operation. For example, the
 user will provide BulkWrite operation models as in the following example:
 
@@ -178,7 +178,7 @@ db.collection.bulkWrite([
 ]);
 ```
 
-The driver must inspect each operation for a Collation if maxWireVersion is \< 5 and fail the entire bulkWrite if a
+The driver must inspect each operation for a Collation if maxWireVersion is < 5 and fail the entire bulkWrite if a
 collation was explicitly specified. In the example above, that means even the insertOne (without Collation) MUST NOT be
 sent.
 
@@ -192,7 +192,7 @@ custom name must be provided for one of them. Then, the test should ensure that
 delete_one is called with an index name.
 
 Drivers should also test that errors are raised in each place Collation can be provided to a API method and the selected
-server has maxWireVersion \< 5.
+server has maxWireVersion < 5.
 
 ## Backwards Compatibility
 

source/collation/collation.md

@@ -449,13 +449,11 @@ penalties, particularly when event listeners are introduced.
 - 2024-09-11: Migrated from reStructuredText to Markdown.
 
 - 2015-09-16: Removed `limit` from find test with options to support 3.2.\
-    Changed find test read preference to
-    `primaryPreferred`.
+    Changed find test read preference to `primaryPreferred`.
 
 - 2015-10-01: Changed find test with a kill cursors to not run on server versions\
-    greater than 3.0. Added a find test
-    with no kill cursors command which only runs on 3.1 and higher. Added notes on which tests should run based on
-    server versions.
+    greater than 3.0. Added a find test with no kill cursors command which only runs on 3.1 and higher. Added notes on
+    which tests should run based on server versions.
 
 - 2015-10-19: Changed batchSize in the 3.2 find tests to expect the remaining value.
 
@@ -478,12 +476,11 @@ penalties, particularly when event listeners are introduced.
 - 2021-05-05: Updated to use hello and legacy hello.
 
 - 2021-08-30: Added `serverConnectionId` field to `CommandStartedEvent`,\
-    `CommandSucceededEvent` and
-    `CommandFailedEvent`.
+    `CommandSucceededEvent` and `CommandFailedEvent`.
 
 - 2022-05-18: Converted legacy tests to the unified test format.
 
-- 2022-09-02: Remove material that only applies to MongoDB versions \< 3.6.
+- 2022-09-02: Remove material that only applies to MongoDB versions < 3.6.
 
 - 2022-10-05: Remove spec front matter and reformat changelog.
 
@@ -492,14 +489,12 @@ penalties, particularly when event listeners are introduced.
 - 2022-11-16: Update sensitive command tests to only run on server versions where the commands are supported.
 
 - 2022-12-13: Updated log message `serverPort` field description to clarify drivers should populate it with the\
-    default
-    port 27017 when relevant. Updated suggested unstructured forms of log messages to more clearly label connection IDs
-    and use more readable server address representations.
+    default port 27017 when relevant. Updated suggested unstructured forms of log messages to more clearly label
+    connection IDs and use more readable server address representations.
 
 - 2023-03-23: Updated `serverConnectionId` field to be Int64 as long-running servers can return Int64.
 
 - 2023-06-13: Added `databaseName` field to `CommandFailedEvent` and `CommandSucceededEvent`.\
-    Updated suggested
-    unstructured forms of log messages reflecting the changes.
+    Updated suggested unstructured forms of log messages reflecting the changes.
 
 - 2023-10-19: Add Q&A section

source/command-logging-and-monitoring/command-logging-and-monitoring.md

@@ -6,7 +6,7 @@
 
 ## Abstract
 
-This specification describes how to implement Wire Protocol Compression between MongoDB drivers and mongo\[d|s\].
+This specification describes how to implement Wire Protocol Compression between MongoDB drivers and mongo[d|s].
 
 Compression is achieved through a new bi-directional wire protocol opcode, referred to as OP_COMPRESSED.
 
@@ -278,7 +278,7 @@ normally.
     {"t":{"$date":"2021-04-20T09:57:26.825-06:00"},"s":"I",  "c":"COMMAND",  "id":51803,   "ctx":"conn5","msg":"Slow query","attr":{"type":"command","ns":"admin.$cmd","command":{"hello":1,"client":{"driver":{"name":"mongo-csharp-driver","version":"2.12.2.0"},"os":{"type":"macOS","name":"Darwin 19.6.0 Darwin Kernel Version 19.6.0: Tue Jan 12 22:13:05 PST 2021; root:xnu-6153.141.16~1/RELEASE_X86_64","architecture":"x86_64","version":"19.6.0"},"platform":".NET 5.0.3"},"compression":[],"$readPreference":{"mode":"secondaryPreferred"},"$db":"admin"},"numYields":0,"reslen":319,"locks":{},"remote":"127.0.0.1:54372","protocol":"op_query","durationMillis":1}}
     ```
 
-    e.g., empty compression: \[\] array. No operations should have been compressed.
+    e.g., empty compression: [] array. No operations should have been compressed.
 
     The results of the program should have been:
 

source/compression/OP_COMPRESSED.md

@@ -553,7 +553,7 @@ encountered, such a [Connection](#connection) MUST be closed (as described in
 list of available [Connections](#connection) is exhausted.
 
 If the list is exhausted, the total number of [Connections](#connection) is less than maxPoolSize, and
-pendingConnectionCount \< maxConnecting, the pool MUST create a [Connection](#connection), establish it, mark it as "in
+pendingConnectionCount < maxConnecting, the pool MUST create a [Connection](#connection), establish it, mark it as "in
 use" and return it. If totalConnectionCount == maxPoolSize or pendingConnectionCount == maxConnecting, then the pool
 MUST wait to service the request until neither of those two conditions are met or until a [Connection](#connection)
 becomes available, re-entering the checkOut loop in either case. This waiting MUST NOT prevent

source/connection-monitoring-and-pooling/connection-monitoring-and-pooling.md

@@ -2274,8 +2274,8 @@ a read preference for the operation. As of `featureCompatibilityVersion` 4.4, se
 `$out` or `$merge`. Since drivers do not track `featureCompatibilityVersion`, the decision to consider a read preference
 for such a pipeline will depend on the wire version(s) of the server(s) to which the driver is connected.
 
-If there are one or more available servers and one or more of those servers is pre-5.0 (i.e. wire version \< 13),
-drivers MUST NOT use the available read preference and MUST instead select a server using a primary read preference.
+If there are one or more available servers and one or more of those servers is pre-5.0 (i.e. wire version < 13), drivers
+MUST NOT use the available read preference and MUST instead select a server using a primary read preference.
 
 Otherwise, if there are either no available servers, all available servers are 5.0+ (i.e. wire version >= 13), or the
 topology type is LoadBalanced (we can assume the backing mongos is 5.0+), drivers MUST use the available read
@@ -2438,11 +2438,10 @@ able to be used as this change is non-backwards breaking. Any driver which imple
 deprecate it and drivers that have not built it should not do so.
 
 Q: Should drivers offer explain helpers?\
-Originally, it was determined that explain should not be exposed via
-specialized APIs in drivers because it it was deemed to be an unusual use-case for a driver. We'd like users to use the
-shell for this purpose. However, explain is still possible from a driver. Some drivers have historically provided
-explain helpers and continue to do so. Drivers that do not offer explain helpers can run explain commands using the
-runCommand API.
+Originally, it was determined that explain should not be exposed via specialized APIs in drivers because it it was
+deemed to be an unusual use-case for a driver. We'd like users to use the shell for this purpose. However, explain is
+still possible from a driver. Some drivers have historically provided explain helpers and continue to do so. Drivers
+that do not offer explain helpers can run explain commands using the runCommand API.
 
 Q: What about explain?
 
@@ -2482,7 +2481,7 @@ release.
 Q: Where is `singleBatch` in FindOptions?
 
 Drivers have historically allowed users to request a single batch of results (after which the cursor is closed) by
-specifying a negative value for the `limit` option. For servers \< 3.2, a single batch may be requested by specifying a
+specifying a negative value for the `limit` option. For servers < 3.2, a single batch may be requested by specifying a
 negative value in the `numberToReturn` wire protocol field. For servers >= 3.2, the `find` command defines `limit` as a
 non-negative integer option but introduces a `singleBatch` boolean option. Rather than introduce a `singleBatch` option
 to FindOptions, the spec preserves the existing API for `limit` and instructs drivers to convert negative values
@@ -2575,7 +2574,7 @@ aforementioned allowance in the SemVer spec.
 
 - 2020-01-10: Clarify client-side error reporting for unsupported options
 
-- 2020-01-10: Error if hint specified for unacknowledged update using OP_UPDATE or OP_MSG for servers \< 4.2
+- 2020-01-10: Error if hint specified for unacknowledged update using OP_UPDATE or OP_MSG for servers < 4.2
 
 - 2019-10-28: Removed link to old language examples.
 

source/crud/crud.md

@@ -42,7 +42,7 @@ Using a 4.0+ server, set the following failpoint:
 Then, perform an insert operation and assert that a WriteConcernError occurs and that its `details` property is both
 accessible and matches the `errInfo` object from the failpoint.
 
-### 2. WriteError.details exposes writeErrors\[\].errInfo
+### 2. WriteError.details exposes writeErrors[].errInfo
 
 Test that `writeErrors[].errInfo` in a command response is propagated as `WriteError.details` (or equivalent) in the
 driver.