Skip to content

Firestore: Small Count API documentation improvements #1511

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 2 commits into from
Jan 10, 2024
Merged

Firestore: Small Count API documentation improvements #1511

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
a9aaafb
Tweak Count API docs
dconeybe Jan 10, 2024
946a0d3
fix 'in cases where'
dconeybe Jan 10, 2024
File filter

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 1 addition & 1 deletion firestore/src/include/firebase/firestore/aggregate_source.h
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -32,7 +32,7 @@ enum class AggregateSource {
* 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
* 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
Expand Down
4 changes: 2 additions & 2 deletions firestore/src/include/firebase/firestore/query.h
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -152,8 +152,8 @@ 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).
* can count the documents in cases where the result set is prohibitively
* large to download entirely (thousands of documents).
*
* @return An aggregate query that counts the documents in the result set of
* this query.
Expand Down