Skip to content

Commit 67fec18

Browse files
committed
addressing comments #3
1 parent 86e3abf commit 67fec18

File tree

1 file changed

+5
-3
lines changed

1 file changed

+5
-3
lines changed

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

Lines changed: 5 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -363,10 +363,12 @@ Task<Void> shutdown() {
363363
}
364364

365365
/**
366-
* Wait until all pending writes existed at the time of calling are sent to the backend.
366+
* Waits until all pending writes that existed at the time of calling have been successfully
367+
* written to the server.
367368
*
368-
* @return A {@link Task} which resolves when all pending writes are sent to the backend. If there
369-
* is a Firebase user change, the return {@link Task} will resolve to an exception.
369+
* @return A {@code Task} which resolves when all pending writes are written to the backend. If
370+
* there is a Firebase user change, the returned {@code Task} will resolve to an exception. If
371+
* the client is offline, the returned {@code Task} will not resolve.
370372
*/
371373
Task<Void> waitForPendingWrites() {
372374
return client.waitForPendingWrites();

0 commit comments

Comments
 (0)