[IMP] add note on Widget insertion methods starting widgets themselves

bzr revid: xmo@openerp.com-20110819135454-3qykqkxukzja36yd

1 files changed, 7 insertions, 0 deletions

diff --git a/doc/source/addons.rst b/doc/source/addons.rst
index 7261e57ebd3..8bff7aae60d 100644
--- a/doc/source/addons.rst
+++ b/doc/source/addons.rst
@@ -195,6 +195,13 @@ The new class can then be used in the following manner:
 After these two lines have executed (and any promise returned by ``appendTo``
 has been resolved if needed), the widget is ready to be used.
 
+.. note:: the insertion methods will start the widget themselves, and will
+          return the result of :js:func:`~openerp.base.Widget.start()`.
+
+          If for some reason you do not want to call these methods, you will
+          have to first call :js:func:`~openerp.base.Widget.render()` on the
+          widget, then insert it into your DOM and start it.
+
 If the widget is not needed anymore (because it's transient), simply terminate
 it: