From 7798bc3b7935bd651bf55d4f2ae22909a5f0ba8a Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Piotrek=20Koszuli=C5=84ski?= Date: Tue, 9 Jan 2018 17:30:53 +0100 Subject: [PATCH] Docs: Improved Editor#ready's documentation. --- src/editor/editor.js | 6 ++++++ 1 file changed, 6 insertions(+) diff --git a/src/editor/editor.js b/src/editor/editor.js index 7c07c27b..b5aa4039 100644 --- a/src/editor/editor.js +++ b/src/editor/editor.js @@ -239,6 +239,12 @@ mix( Editor, ObservableMixin ); * Fired when {@link #event:pluginsReady plugins}, {@link #event:uiReady UI} and {@link #event:dataReady data} and all additional * editor components are ready. * + * Note: This event is most useful for plugin developers. When integrating the editor with your website or + * application you do not have to listen to `editor#ready` because when the promise returned by the static + * {@link #create `Editor.create()`} event is resolved, the editor is already ready. In fact, since the first moment + * when the editor instance is available to you is inside `then()`'s callback, you cannot even add a listener to + * the `editor#ready` event. + * * @event ready */