Addressing documentation comments.

wu-hui · wu-hui · commit d0588f8c2d88 · 2020-11-27T10:10:37.000-05:00
diff --git a/google-cloud-firestore/src/main/java/com/google/cloud/firestore/Firestore.java b/google-cloud-firestore/src/main/java/com/google/cloud/firestore/Firestore.java
@@ -170,8 +170,8 @@ void getAll(
 
   /**
    * Returns a FirestoreBundle.Builder {@link FirestoreBundle.Builder} instance using an
-   * automatically generated ID. The ID is used by the client SDKs loading bundles to identify if a
-   * bundle has been loaded before.
+   * automatically generated bundle ID. When loaded on clients, client SDKs use the bundle ID and
+   * the timestamp associated with the built bundle to tell if it has been loaded already.
    */
   @Nonnull
   FirestoreBundle.Builder bundleBuilder();
@@ -180,8 +180,8 @@ void getAll(
    * Returns a FirestoreBundle.Builder {@link FirestoreBundle.Builder} instance for the given bundle
    * ID.
    *
-   * @param bundleId The ID is used by the client SDKs loading bundles to identify if a bundle has
-   *     been loaded before. If null, a random string will be used for the ID.
+   * @param bundleId The ID of the bundle. When loaded on clients, client SDKs use this id and the
+   *     timestamp associated with the built bundle to tell if it has been loaded already.
    */
   @Nonnull
   FirestoreBundle.Builder bundleBuilder(@Nonnull String bundleId);
diff --git a/google-cloud-firestore/src/main/java/com/google/cloud/firestore/FirestoreBundle.java b/google-cloud-firestore/src/main/java/com/google/cloud/firestore/FirestoreBundle.java
@@ -64,7 +64,7 @@ public String getId() {
     }
 
     /**
-     * Adds a Firestore document snapshot to the bundle. Both the documents data and the document
+     * Adds a Firestore document snapshot to the bundle. Both the document data and the document
      * read time will be included in the bundle.
      *
      * @param documentSnapshot A document snapshot to add.
@@ -126,7 +126,7 @@ private Builder add(DocumentSnapshot documentSnapshot, Optional<String> queryNam
     }
 
     /**
-     * Adds a Firestore query snapshots to the bundle. Both the documents in the query snapshots and
+     * Adds a Firestore query snapshot to the bundle. Both the documents in the query snapshot and
      * the query read time will be included in the bundle.
      *
      * @param queryName The name of the query to add.

Original file line number	Diff line number	Diff line change
`@@ -64,7 +64,7 @@ public String getId() {`
`64`	`64`	`}`
`65`	`65`
`66`	`66`	`/**`
`67`		`- * Adds a Firestore document snapshot to the bundle. Both the documents data and the document`
	`67`	`+ * Adds a Firestore document snapshot to the bundle. Both the document data and the document`
`68`	`68`	`* read time will be included in the bundle.`
`69`	`69`	`*`
`70`	`70`	`* @param documentSnapshot A document snapshot to add.`
`@@ -126,7 +126,7 @@ private Builder add(DocumentSnapshot documentSnapshot, Optional<String> queryNam`
`126`	`126`	`}`
`127`	`127`
`128`	`128`	`/**`
`129`		`- * Adds a Firestore query snapshots to the bundle. Both the documents in the query snapshots and`
	`129`	`+ * Adds a Firestore query snapshot to the bundle. Both the documents in the query snapshot and`
`130`	`130`	`* the query read time will be included in the bundle.`
`131`	`131`	`*`
`132`	`132`	`* @param queryName The name of the query to add.`