docs: Clarify that update() Future only completes when download is done. (#236)

2024-11-11 12:56:10 -08:00
parent c06b5df4e9
commit 59bcb311d5
1 changed files with 2 additions and 0 deletions
@@ -125,6 +125,8 @@ abstract class ShorebirdUpdater {
  Future<UpdateStatus?> checkForUpdate();

  /// Updates the app to the latest patch (if available).
+  /// Future will complete once the update is fully downloaded and ready
+  /// to be used on the next app start.
  /// Note: The app must be restarted for the update to take effect.
  /// Note: This method does nothing if the updater is not available.
  ///