From 89a9ccab8bccb0953e3230874163af52dede383e Mon Sep 17 00:00:00 2001 From: Zeke Sikelianos Date: Tue, 24 Jul 2018 15:33:53 -0700 Subject: [PATCH] docs: clarify default auto-updater installation behavior (#12783) * docs: clarify default auto-updater installation behavior * remove redundant note --- docs/api/auto-updater.md | 9 ++++++--- 1 file changed, 6 insertions(+), 3 deletions(-) diff --git a/docs/api/auto-updater.md b/docs/api/auto-updater.md index bb181347a0ae..7f840f07102a 100644 --- a/docs/api/auto-updater.md +++ b/docs/api/auto-updater.md @@ -84,6 +84,9 @@ Emitted when an update has been downloaded. On Windows only `releaseName` is available. +**Note:** It is not strictly necessary to handle this event. A successfully +downloaded update will still be applied the next time the application starts. + ### Event: 'before-quit-for-update' This event is emitted after a user calls `quitAndInstall()`. @@ -122,9 +125,9 @@ Under the hood calling `autoUpdater.quitAndInstall()` will close all application windows first, and automatically call `app.quit()` after all windows have been closed. -**Note:** If the application is quit without calling this API after the -`update-downloaded` event has been emitted, the application will still be -replaced by the updated one on the next run. +**Note:** It is not strictly necessary to call this function to apply an update, +as a successfully downloaded update will always be applied the next time the +application starts. [squirrel-mac]: https://github.com/Squirrel/Squirrel.Mac [server-support]: https://github.com/Squirrel/Squirrel.Mac#server-support