From 4ae0c5d6813cd9de39d45f0fc6be6e1f85c5a174 Mon Sep 17 00:00:00 2001 From: Denver Coneybeare Date: Wed, 10 Jan 2024 16:21:23 -0500 Subject: [PATCH] Firestore: Small Count API documentation improvements (#12254) --- .../Public/FirebaseFirestore/FIRAggregateSource.h | 2 +- .../Source/Public/FirebaseFirestore/FIRQuery.h | 15 ++++++++------- 2 files changed, 9 insertions(+), 8 deletions(-) diff --git a/Firestore/Source/Public/FirebaseFirestore/FIRAggregateSource.h b/Firestore/Source/Public/FirebaseFirestore/FIRAggregateSource.h index 365aec30c49..b3613b2b75f 100644 --- a/Firestore/Source/Public/FirebaseFirestore/FIRAggregateSource.h +++ b/Firestore/Source/Public/FirebaseFirestore/FIRAggregateSource.h @@ -30,7 +30,7 @@ typedef NS_ENUM(NSUInteger, FIRAggregateSource) { * The result received from the server is presented, unaltered, without considering any local * state. That is, documents in the local cache are not taken into consideration, neither are * local modifications not yet synchronized with the server. Previously-downloaded results, if - * any, are not used: every request using this source necessarily involves a round trip to the + * any, are not used. Every request using this source necessarily involves a round trip to the * server. * * The `AggregateQuery` will fail if the server cannot be reached, such as if the client is diff --git a/Firestore/Source/Public/FirebaseFirestore/FIRQuery.h b/Firestore/Source/Public/FirebaseFirestore/FIRQuery.h index 843dff16090..bde102c212a 100644 --- a/Firestore/Source/Public/FirebaseFirestore/FIRQuery.h +++ b/Firestore/Source/Public/FirebaseFirestore/FIRQuery.h @@ -556,22 +556,23 @@ NS_SWIFT_NAME(Query) #pragma mark - Aggregation /** - * A query that counts the documents in the result set of this query, without actually downloading + * A query that counts the documents in the result set of this query without actually downloading * the documents. * - * Using this `AggregateQuery` to count the documents is efficient because only the final count, - * not the documents' data, is downloaded. This allows for counting document collections that would - * otherwise be too large to download (e.g. containing thousands of documents). + * Using this `AggregateQuery` to count the documents is efficient because only the final count, not + * the documents' data, is downloaded. The `AggregateQuery` can count the documents in cases where + * the result set is prohibitively large to download entirely (thousands of documents). */ @property(nonatomic, readonly) FIRAggregateQuery *count; /** * Creates and returns a new `AggregateQuery` that aggregates the documents in the result set - * of this query, without actually downloading the documents. + * of this query without actually downloading the documents. * * Using an `AggregateQuery` to perform aggregations is efficient because only the final aggregation - * values, not the documents' data, is downloaded. This allows for aggregating document collections - * that would otherwise be too large to download (e.g. containing thousands of documents). + * values, not the documents' data, is downloaded. The returned `AggregateQuery` can perform + * aggregations of the documents in cases where the result set is prohibitively large to download + * entirely (thousands of documents). * * @param aggregateFields Specifies the aggregate operations to perform on the result set of this * query.