chore: code review

Co-authored-by: Aditi Khare <[email protected]>

Author: nbbeeken

src/mongo_client.ts

@@ -510,11 +510,11 @@ export class MongoClient extends TypedEventEmitter<MongoClientEvents> implements
    * Connect to MongoDB using a url
    *
    * @remarks
-   * Calling connect is optional as the first operation you preform will call connect if it's needed.
+   * 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.
-   * 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.
+   * However, when the operation being run is automatically connecting your `MongoClient` the timeoutMS will only be used for the operation portion of task.
+   * 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.
    *
    * @see docs.mongodb.org/manual/reference/connection-string/
    */
@@ -713,11 +713,11 @@ export class MongoClient extends TypedEventEmitter<MongoClientEvents> implements
    * Connect to MongoDB using a url
    *
    * @remarks
-   * Calling connect is optional as the first operation you preform will call connect if it's needed.
+   * 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.
-   * 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.
+   * However, when the operation being run is automatically connecting your `MongoClient` the timeoutMS will only be used for the operation portion of task.
+   * 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.
    *
    * @remarks
    * The programmatically provided options take precedence over the URI options.

test/integration/node-specific/auto_connect.test.ts

@@ -824,7 +824,7 @@ describe('When executing an operation for the first time', () => {
     });
   });
 
-  describe('and CSOT is enabled', function () {
+  describe('when CSOT is enabled', function () {
     let client: MongoClient;
 
     beforeEach(async function () {
@@ -835,14 +835,14 @@ describe('When executing an operation for the first time', () => {
       await client.close();
     });
 
-    describe('and nothing is wrong', function () {
+    describe('when nothing is wrong', function () {
       it('connects the client', async function () {
         await client.connect();
         expect(client).to.have.property('topology').that.is.instanceOf(Topology);
       });
     });
 
-    describe('and the server requires auth and ping is delayed', function () {
+    describe('when the server requires auth and ping is delayed', function () {
       beforeEach(async function () {
         // set failpoint to delay ping
         // create new util client to avoid affecting the test client
@@ -856,7 +856,7 @@ describe('When executing an operation for the first time', () => {
       });
 
       it(
-        'takes as long as ping is delayed for and does not throw a timeout error',
+        'client.connect() takes as long as ping is delayed for and does not throw a timeout error',
         { requires: { auth: 'enabled' } },
         async function () {
           const start = performance.now();
@@ -886,7 +886,7 @@ describe('When executing an operation for the first time', () => {
       });
 
       it(
-        'takes as long as selectServer is delayed for and does not throw a timeout error',
+        'client.connect() 'takes as long as selectServer is delayed for and does not throw a timeout error',
         { requires: { auth: 'enabled' } },
         async function () {
           const start = performance.now();