docs: elaborate on QuerySnapshot.forEach (#480)

googleapis · Dec 6, 2018 · a015d37 · a015d37
1 parent 5627e79
commit a015d37
Showing 1 changed file with 3 additions and 1 deletion.
diff --git a/dev/src/reference.ts b/dev/src/reference.ts
@@ -777,7 +777,9 @@ export class QuerySnapshot {
   }
 
   /**
-   * Enumerates all of the documents in the QuerySnapshot.
+   * Enumerates all of the documents in the QuerySnapshot. This is a convenience
+   * method for running the same callback on each {@link QueryDocumentSnapshot}
+   * that is returned.
    *
    * @param {function} callback A callback to be called with a
    * [QueryDocumentSnapshot]{@link QueryDocumentSnapshot} for each document in