From a29d34a58bf57363df48ad5cc1ef206256215cc9 Mon Sep 17 00:00:00 2001 From: Denver Coneybeare Date: Wed, 10 Jan 2024 16:43:59 -0500 Subject: [PATCH] docs: tweak Count API docs (#1974) --- dev/src/reference.ts | 11 ++++++----- types/firestore.d.ts | 11 ++++++----- 2 files changed, 12 insertions(+), 10 deletions(-) diff --git a/dev/src/reference.ts b/dev/src/reference.ts index 012634c8f..dd9af2e58 100644 --- a/dev/src/reference.ts +++ b/dev/src/reference.ts @@ -1839,8 +1839,8 @@ export class Query< * * Using the returned query to count the documents is efficient because only * the final count, not the documents' data, is downloaded. The returned - * query can even count the documents if the result set would be - * prohibitively large to download entirely (e.g. thousands of documents). + * query can count the documents in cases where the result set is + * prohibitively large to download entirely (thousands of documents). * * @return a query that counts the documents in the result set of this * query. The count can be retrieved from `snapshot.data().count`, where @@ -1861,13 +1861,14 @@ export class Query< * Returns a query that can perform the given aggregations. * * The returned query, when executed, calculates the specified aggregations - * over the documents in the result set of this query, without actually + * over the documents in the result set of this query without actually * downloading the documents. * * Using the returned query to perform aggregations is efficient because only * the final aggregation values, not the documents' data, is downloaded. The - * returned query can even perform aggregations of the documents if the result set - * would be prohibitively large to download entirely (e.g. thousands of documents). + * returned query can perform aggregations of the documents count the + * documents in cases where the result set is prohibitively large to download + * entirely (thousands of documents). * * @param aggregateSpec An `AggregateSpec` object that specifies the aggregates * to perform over the result set. The AggregateSpec specifies aliases for each diff --git a/types/firestore.d.ts b/types/firestore.d.ts index 8d19fd5cf..9f4c2928c 100644 --- a/types/firestore.d.ts +++ b/types/firestore.d.ts @@ -1910,8 +1910,8 @@ declare namespace FirebaseFirestore { * * Using the returned query to count the documents is efficient because only * the final count, not the documents' data, is downloaded. The returned - * query can even count the documents if the result set would be - * prohibitively large to download entirely (e.g. thousands of documents). + * query can count the documents in cases where the result set is + * prohibitively large to download entirely (thousands of documents). * * @return a query that counts the documents in the result set of this * query. The count can be retrieved from `snapshot.data().count`, where @@ -1928,13 +1928,14 @@ declare namespace FirebaseFirestore { * Returns a query that can perform the given aggregations. * * The returned query, when executed, calculates the specified aggregations - * over the documents in the result set of this query, without actually + * over the documents in the result set of this query without actually * downloading the documents. * * Using the returned query to perform aggregations is efficient because only * the final aggregation values, not the documents' data, is downloaded. The - * returned query can even perform aggregations of the documents if the result set - * would be prohibitively large to download entirely (e.g. thousands of documents). + * returned query can perform aggregations of the documents in cases where + * the result set is prohibitively large to download entirely (thousands of + * documents). * * @param aggregateSpec An `AggregateSpec` object that specifies the aggregates * to perform over the result set. The AggregateSpec specifies aliases for each