docs(platform): Explain ionic.Platform.ready() further

ionic-team · Apr 6, 2014 · ead30f2 · ead30f2
1 parent 3a57712
commit ead30f2
Showing 1 changed file with 6 additions and 2 deletions.
diff --git 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) {