From fce2c1165f975b808e24b44ca1024509c527e17b Mon Sep 17 00:00:00 2001 From: Chris Wilcox Date: Wed, 5 Dec 2018 15:42:27 -0800 Subject: [PATCH] docs: elaborate on QuerySnapshot.forEach --- dev/src/reference.ts | 4 +++- 1 file changed, 3 insertions(+), 1 deletion(-) diff --git a/dev/src/reference.ts b/dev/src/reference.ts index 69a5eb3ca..f07fb1270 100644 --- 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