Fix documentation for getDocsFromCache. (#6879)

Fix documentation for getDocsFromCache.
firebase · Dec 12, 2022 · 37f31c5 · 37f31c5
1 parent 70e6254
commit 37f31c5
Show file tree

Hide file tree

Showing 2 changed files with 7 additions and 1 deletion.
diff --git a/.changeset/wild-frogs-play.md b/.changeset/wild-frogs-play.md
@@ -0,0 +1,5 @@
+---
+"@firebase/firestore": patch
+---
+
+Fix documentation for getDocsFromCache.
diff --git a/packages/firestore/src/api/reference_impl.ts b/packages/firestore/src/api/reference_impl.ts
@@ -196,7 +196,8 @@ export function getDocs<T>(query: Query<T>): Promise<QuerySnapshot<T>> {
 
 /**
  * Executes the query and returns the results as a `QuerySnapshot` from cache.
- * Returns an error if the document is not currently cached.
+ * Returns an empty result set if no documents matching the query are currently
+ * cached.
  *
  * @returns A `Promise` that will be resolved with the results of the query.
  */