chore: bailey's comments

nbbeeken · nbbeeken · commit f38430b0e8f8 · 2024-10-22T13:34:13.000-04:00
diff --git a/src/mongo_client.ts b/src/mongo_client.ts
@@ -515,8 +515,8 @@ export class MongoClient extends TypedEventEmitter<MongoClientEvents> implements
    *
    * @remarks
    * Calling `connect` is optional since the first operation you perform will call `connect` if it's needed.
-   * `timeoutMS` specified at the client-level will bound the time any operation can take before throwing a timeout error.
-   * However, when the operation being run is automatically connecting your `MongoClient` the `timeoutMS` will only be used for the operation portion of task.
+   * `timeoutMS` will bound the time any operation can take before throwing a timeout error.
+   * However, when the operation being run is automatically connecting your `MongoClient` the `timeoutMS` will not apply to the time taken to connect the MongoClient.
    * This means the time to setup the `MongoClient` does not count against `timeoutMS`.
    * If you are using `timeoutMS` we recommend connecting your client explicitly in advance of any operation to avoid this inconsistent execution time.
    *
@@ -718,8 +718,8 @@ export class MongoClient extends TypedEventEmitter<MongoClientEvents> implements
    *
    * @remarks
    * Calling `connect` is optional since the first operation you perform will call `connect` if it's needed.
-   * `timeoutMS` specified at the client-level will bound the time any operation can take before throwing a timeout error.
-   * However, when the operation being run is automatically connecting your `MongoClient` the `timeoutMS` will only be used for the operation portion of task.
+   * `timeoutMS` will bound the time any operation can take before throwing a timeout error.
+   * However, when the operation being run is automatically connecting your `MongoClient` the `timeoutMS` will not apply to the time taken to connect the MongoClient.
    * This means the time to setup the `MongoClient` does not count against `timeoutMS`.
    * If you are using `timeoutMS` we recommend connecting your client explicitly in advance of any operation to avoid this inconsistent execution time.
    *

Original file line number	Diff line number	Diff line change
`@@ -515,8 +515,8 @@ export class MongoClient extends TypedEventEmitter<MongoClientEvents> implements`
`515`	`515`	`*`
`516`	`516`	`* @remarks`
`517`	`517`	* Calling `connect` is optional since the first operation you perform will call `connect` if it's needed.
`518`		- * `timeoutMS` specified at the client-level will bound the time any operation can take before throwing a timeout error.
`519`		- * However, when the operation being run is automatically connecting your `MongoClient` the `timeoutMS` will only be used for the operation portion of task.
	`518`	+ * `timeoutMS` will bound the time any operation can take before throwing a timeout error.
	`519`	+ * However, when the operation being run is automatically connecting your `MongoClient` the `timeoutMS` will not apply to the time taken to connect the MongoClient.
`520`	`520`	* This means the time to setup the `MongoClient` does not count against `timeoutMS`.
`521`	`521`	* If you are using `timeoutMS` we recommend connecting your client explicitly in advance of any operation to avoid this inconsistent execution time.
`522`	`522`	`*`
`@@ -718,8 +718,8 @@ export class MongoClient extends TypedEventEmitter<MongoClientEvents> implements`
`718`	`718`	`*`
`719`	`719`	`* @remarks`
`720`	`720`	* Calling `connect` is optional since the first operation you perform will call `connect` if it's needed.
`721`		- * `timeoutMS` specified at the client-level will bound the time any operation can take before throwing a timeout error.
`722`		- * However, when the operation being run is automatically connecting your `MongoClient` the `timeoutMS` will only be used for the operation portion of task.
	`721`	+ * `timeoutMS` will bound the time any operation can take before throwing a timeout error.
	`722`	+ * However, when the operation being run is automatically connecting your `MongoClient` the `timeoutMS` will not apply to the time taken to connect the MongoClient.
`723`	`723`	* This means the time to setup the `MongoClient` does not count against `timeoutMS`.
`724`	`724`	* If you are using `timeoutMS` we recommend connecting your client explicitly in advance of any operation to avoid this inconsistent execution time.
`725`	`725`	`*`