Skip to content

Commit 4ae0c5d

Browse files
authored
Firestore: Small Count API documentation improvements (#12254)
1 parent 7db032c commit 4ae0c5d

File tree

2 files changed

+9
-8
lines changed

2 files changed

+9
-8
lines changed

Firestore/Source/Public/FirebaseFirestore/FIRAggregateSource.h

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -30,7 +30,7 @@ typedef NS_ENUM(NSUInteger, FIRAggregateSource) {
3030
* The result received from the server is presented, unaltered, without considering any local
3131
* state. That is, documents in the local cache are not taken into consideration, neither are
3232
* local modifications not yet synchronized with the server. Previously-downloaded results, if
33-
* any, are not used: every request using this source necessarily involves a round trip to the
33+
* any, are not used. Every request using this source necessarily involves a round trip to the
3434
* server.
3535
*
3636
* The `AggregateQuery` will fail if the server cannot be reached, such as if the client is

Firestore/Source/Public/FirebaseFirestore/FIRQuery.h

Lines changed: 8 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -556,22 +556,23 @@ NS_SWIFT_NAME(Query)
556556
#pragma mark - Aggregation
557557

558558
/**
559-
* A query that counts the documents in the result set of this query, without actually downloading
559+
* A query that counts the documents in the result set of this query without actually downloading
560560
* the documents.
561561
*
562-
* Using this `AggregateQuery` to count the documents is efficient because only the final count,
563-
* not the documents' data, is downloaded. This allows for counting document collections that would
564-
* otherwise be too large to download (e.g. containing thousands of documents).
562+
* Using this `AggregateQuery` to count the documents is efficient because only the final count, not
563+
* the documents' data, is downloaded. The `AggregateQuery` can count the documents in cases where
564+
* the result set is prohibitively large to download entirely (thousands of documents).
565565
*/
566566
@property(nonatomic, readonly) FIRAggregateQuery *count;
567567

568568
/**
569569
* Creates and returns a new `AggregateQuery` that aggregates the documents in the result set
570-
* of this query, without actually downloading the documents.
570+
* of this query without actually downloading the documents.
571571
*
572572
* Using an `AggregateQuery` to perform aggregations is efficient because only the final aggregation
573-
* values, not the documents' data, is downloaded. This allows for aggregating document collections
574-
* that would otherwise be too large to download (e.g. containing thousands of documents).
573+
* values, not the documents' data, is downloaded. The returned `AggregateQuery` can perform
574+
* aggregations of the documents in cases where the result set is prohibitively large to download
575+
* entirely (thousands of documents).
575576
*
576577
* @param aggregateFields Specifies the aggregate operations to perform on the result set of this
577578
* query.

0 commit comments

Comments
 (0)