From ead30f2ed588772520b43593f68603824a4e80fe Mon Sep 17 00:00:00 2001 From: Adam Bradley Date: Sat, 5 Apr 2014 20:46:17 -0500 Subject: [PATCH] docs(platform): Explain ionic.Platform.ready() further --- js/utils/platform.js | 8 ++++++-- 1 file changed, 6 insertions(+), 2 deletions(-) diff --git a/js/utils/platform.js b/js/utils/platform.js index 3d50066492..bf774d229a 100644 --- a/js/utils/platform.js +++ b/js/utils/platform.js @@ -37,8 +37,12 @@ * @ngdoc method * @name ionic.Platform#ready * @description - * Trigger a callback once the device is ready, - * or immediately if the device is already ready. + * Trigger a callback once the device is ready, or immediately + * if the device is already ready. This method can be ran from + * anywhere and does not need to be wrapped by any additonal methods. + * When the app is within a WebView (Cordova), it'll fire + * the callback once the device is ready. If the app is within + * a web browser, it'll fire the callback after `window.load`. * @param {function} callback The function to call. */ ready: function(cb) {