[ADD] docstring about qweb usage

bzr revid: xmo@openerp.com-20131008070742-4k1egtvmdvz3pv6e
This commit is contained in:
Xavier Morel 2013-10-08 09:07:42 +02:00
parent 47fc0a1093
commit 5e1c17a3a7
1 changed files with 11 additions and 0 deletions

View File

@ -73,7 +73,18 @@ class QWeb(orm.AbstractModel):
- loader: function that return a template
QWeb rendering can be used for many tasks. As a result, customizations
made by one task context (to either the main qweb rendering or to specific
fields rendering) could break other tasks.
To avoid that, ``ir.qweb`` was consciously made inheritable and the "root"
of an object hierarchy. If you need extensions or alterations which could
be incompatible with other subsystems, you should create a local object
inheriting from ``ir.qweb`` and customize that.
If you need to customize t-fields rendering, subclass the ir.qweb.field
model (and its sub-models) then override :meth:`~.get_converter_for` to
fetch the right field converters for your qweb model.
"""
_name = 'ir.qweb'