Skip to content

Commit 95f26d1

Browse files
Apply suggestions from code review
batchable suggestions Co-authored-by: Daria Pardue <daria.pardue@mongodb.com>
1 parent bc776ab commit 95f26d1

File tree

3 files changed

+4
-4
lines changed

3 files changed

+4
-4
lines changed

source/client-side-operations-timeout/client-side-operations-timeout.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -429,7 +429,7 @@ See [runCommand behavior](#runcommand-behavior).
429429

430430
### Explain Helpers
431431

432-
If a driver provides an explain helper, drivers MUST take care to ensure that timeoutMS is correctly applied to the
432+
If a driver provides an explain helper, drivers MUST take care to ensure that `timeoutMS` is correctly applied to the
433433
explain command, when specified. Care should be taken by drivers with a fluent API - the following example
434434
should apply a timeoutMS of 1000 to the `explain` command:
435435

source/crud/crud.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -2201,7 +2201,7 @@ the [$readPreference global command argument](../message/OP_MSG.md#global-comman
22012201
### Explain
22022202

22032203
Drivers MAY provide explain helpers. If a driver does provide explain helpers, the driver MUST ensure that its helper
2204-
permits users to specify maxTimeMS for the explain command. An example, using Node.js, might look like:
2204+
permits users to specify `maxTimeMS` for the explain command. An example, using Node.js, might look like:
22052205

22062206
```typescript
22072207
collection.find({ name: 'john doe' }).explain({ maxTimeMS: 1000 });
@@ -2327,7 +2327,7 @@ Originally, it was determined that explain should not be exposed via
23272327
specialized APIs in drivers (runCommand was always an option after server 3.0.). However, some drivers historically have
23282328
offered explain APIs and continue to do so.
23292329

2330-
Explain helpers are not required because it has been determined to be not a normal use-case for a driver. We'd like
2330+
Explain helpers are optional because it has been determined to be not a normal use-case for a driver. We'd like
23312331
users to use the shell for this purpose. However, explain is still possible from a driver. For find, it can be passed as
23322332
a modifier. Aggregate can be run using a runCommand method passing the explain option. In addition, server 3.0 offers an
23332333
explain command that can be run using a runCommand method.

source/crud/tests/README.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -684,7 +684,7 @@ Create a MongoClient with command monitoring enabled (referred to as `client`).
684684
Create a collection, referred to as `collection`, with the namespace `explain-test.collection`.
685685

686686
Run an explained find on `collection`. The find will have the query predicate `{ name: 'john doe' }`. Specify a
687-
maxTimeMS value of 2000ms for the `explain`.
687+
`maxTimeMS` value of 2000ms for the `explain`.
688688

689689
Obtain the command started event for the explain. Confirm that the top-level explain command should has a `maxTimeMS`
690690
value of `2000`.

0 commit comments

Comments
 (0)