Matt's comments

mongodb · Sep 12, 2024 · 5d66a90 · 5d66a90
1 parent dbe161f
commit 5d66a90
Show file tree

Hide file tree

Showing 2 changed files with 6 additions and 5 deletions.
diff --git a/source/client-side-operations-timeout/client-side-operations-timeout.md b/source/client-side-operations-timeout/client-side-operations-timeout.md
@@ -433,12 +433,13 @@ See [runCommand behavior](#runcommand-behavior).
 > [!NOTE]
 > This portion of the specification is only relevant for drivers that provide `explain` helpers.
 
-When `timeoutMS` is specified, drivers MUST take care to ensure that timeoutMS is correctly applied to the top-level
-explain command. Care should be taken by drivers with a fluent API - the following example should apply a timeoutMS of
-1000 to the `explain` command:
+When `timeoutMS` is specified, drivers MUST provide a way to specify timeoutMS that results in maxTimeMS being set on
+the `explain` command. For example, Node's implementation might look like:
 
 ```typescript
-collection.find({}, { timeoutMS: 1000 }).explain();
+collection.find({}).explain({ timeoutMS: 1000 });
+// sends:
+{ explain: { find: ... }, maxTimeMS: <remaining timeoutMS - min rtt>}
 ```
 
 ## Test Plan

diff --git a/source/crud/crud.md b/source/crud/crud.md
@@ -2234,7 +2234,7 @@ collection.find({ name: 'john doe' }).explain({ timeoutMS: 1000 });
 // sends:
 { 
   explain: { find: <collection>, query: { name: 'john doe' } },
-  maxTimeMS: <1000 - average rtt>
+  maxTimeMS: <1000 - min rtt>
 }
 ```