diff --git a/shorebird_code_push/lib/src/shorebird_updater.dart b/shorebird_code_push/lib/src/shorebird_updater.dart index 6b749ae..d46eab3 100644 --- a/shorebird_code_push/lib/src/shorebird_updater.dart +++ b/shorebird_code_push/lib/src/shorebird_updater.dart @@ -125,6 +125,8 @@ abstract class ShorebirdUpdater { Future 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. ///