Skip to content

Commit 7bfaf83

Browse files
authored
Improve auto cache index creation documentation readability (#5298)
1 parent 66041ec commit 7bfaf83

File tree

3 files changed

+6
-5
lines changed

3 files changed

+6
-5
lines changed

firebase-firestore/CHANGELOG.md

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,6 @@
11
# Unreleased
2-
* [feature] Add option to allow SDK create cache indexes automatically to improve query execution locally. [`db.getPersistentCacheIndexManager().enableIndexAutoCreation()`](//github.com/firebase/firebase-android-sdk/pull/4987)
2+
* [feature] Add the option to allow the SDK to create cache indexes automatically to
3+
improve query execution locally. [`db.getPersistentCacheIndexManager().enableIndexAutoCreation()`](//github.com/firebase/firebase-android-sdk/pull/4987)
34

45
# 24.7.1
56
* [fixed] Implement equals method on Filter class. [#5210](//github.com/firebase/firebase-android-sdk/issues/5210)

firebase-firestore/src/main/java/com/google/firebase/firestore/FirebaseFirestore.java

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -356,8 +356,8 @@ public FirebaseApp getApp() {
356356
* @return A task that resolves once all indices are successfully configured.
357357
* @throws IllegalArgumentException if the JSON format is invalid
358358
* @deprecated Instead of creating cache indexes manually, consider using {@link
359-
* PersistentCacheIndexManager#enableIndexAutoCreation()} to let SDK decide whether to create
360-
* cache indexes for queries running locally.
359+
* PersistentCacheIndexManager#enableIndexAutoCreation()} to let the SDK decide whether to
360+
* create cache indexes for queries running locally.
361361
*/
362362
@Deprecated
363363
@PreviewApi

firebase-firestore/src/main/java/com/google/firebase/firestore/PersistentCacheIndexManager.java

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -52,8 +52,8 @@ public void disableIndexAutoCreation() {
5252
}
5353

5454
/**
55-
* Removes all persistent cache indexes. Please note this function will also deletes indexes
56-
* generated by {@link FirebaseFirestore#setIndexConfiguration(String)}, which is deprecated.
55+
* Removes all persistent cache indexes. Please note this function also deletes indexes generated
56+
* by {@link FirebaseFirestore#setIndexConfiguration(String)}, which is deprecated.
5757
*/
5858
public void deleteAllIndexes() {
5959
client.deleteAllFieldIndexes();

0 commit comments

Comments
 (0)