addressing comments #2

Author: wu-hui

packages/firestore/src/api/database.ts

@@ -483,13 +483,13 @@ export class Firestore implements firestore.FirebaseFirestore, FirebaseService {
    * backend.
    *
    * The returned Promise resolves immediately if there are no outstanding writes. Otherwise, the
-   * Task waits for all previously issued writes (including those written in a previous app
+   * Promise waits for all previously issued writes (including those written in a previous app
    * session), but it does not wait for writes that were added after the method is called. If you
    * wish to wait for additional writes, you have to call `waitForPendingWrites()` again.
    *
    * Any outstanding `waitForPendingWrites()` Promises are rejected during user changes.
    *
-   * @return A `Promise` which resolves when all currently pending writes have been
+   * @return A Promise which resolves when all currently pending writes have been
    * acknowledged by the backend.
    */
   _waitForPendingWrites(): Promise<void> {

packages/firestore/src/core/firestore_client.ts

@@ -523,9 +523,9 @@ export class FirestoreClient {
   }
 
   /**
-   * Returns a Promise that resolves when when all writes that were pending at the time when this
-   * method is called received server acknowledgement. An acknowledgement can be either acceptance
-   * or rejections.
+   * Returns a Promise that resolves when all writes that were pending at the time this
+   * method was called received server acknowledgement. An acknowledgement can be either acceptance
+   * or rejection.
    */
   waitForPendingWrites(): Promise<void> {
     this.verifyNotShutdown();

packages/firestore/src/core/sync_engine.ts

@@ -610,9 +610,8 @@ export class SyncEngine implements RemoteSyncer, SharedClientStateSyncer {
   }
 
   /**
-   * Registers a user callback with all the pending mutations at the moment of calling.
-   * When all those mutations are either accepted or rejected by the server, the
-   * registered callback will be triggered.
+   * Registers a user callback that resolves when all pending mutations at the moment of calling
+   * are acknowledged .
    */
   async registerPendingWritesCallback(callback: Deferred<void>): Promise<void> {
     if (!this.remoteStore.canUseNetwork()) {

packages/firestore/test/integration/api/database.test.ts

@@ -1162,10 +1162,9 @@ apiDescribe('Database', (persistence: boolean) => {
         // Prevent pending writes receiving acknowledgement.
         await firestore.disableNetwork();
 
-      // `awaitsPendingWrites` is created when there is no pending writes, it will resolve
-      // immediately even if we are offline.
-        const awaitPendingWrites = waitForPendingWrites(firestore);
-        await awaitPendingWrites;
+        // `awaitsPendingWrites` is created when there is no pending writes, it will resolve
+        // immediately even if we are offline.
+        await waitForPendingWrites(firestore);
       });
     });
 });