From 69f53147d9e79feef78dc9b16eae46b2adb75e32 Mon Sep 17 00:00:00 2001
From: =?UTF-8?q?Thibault=20Delavall=C3=A9e?= <tde@openerp.com>
Date: Wed, 19 Dec 2012 10:38:44 +0100
Subject: [PATCH] [DOC] mail: added a comment about _track structure.

bzr revid: tde@openerp.com-20121219093844-8p97xhnq4i7yqn4l
---
 addons/mail/mail_thread.py | 16 ++++++++++++++++
 1 file changed, 16 insertions(+)

diff --git a/addons/mail/mail_thread.py b/addons/mail/mail_thread.py
index 98d28d9bbf7..97608c0d080 100644
--- a/addons/mail/mail_thread.py
+++ b/addons/mail/mail_thread.py
@@ -73,6 +73,22 @@ class mail_thread(osv.AbstractModel):
     _name = 'mail.thread'
     _description = 'Email Thread'
     _mail_flat_thread = True
+
+    # Automatic logging system if mail installed
+    # _track = {
+    #   'field': {
+    #       'module.subtype_xml': lambda self, cr, uid, obj, context=None: obj.state == done,
+    #       'module.subtype_xml2': lambda self, cr, uid, obj, context=None: obj.state != done,
+    #   },
+    #   'field2': {
+    #       ...
+    #   },
+    # }
+    # where
+    #   :param string field: field name
+    #   :param module.subtype_xml: xml_id of a mail.message.subtype (i.e. mail.mt_comment)
+    #   :param obj: is a browse_record
+    #   :param function lambda: returns whether the tracking should record using this subtype
     _track = {}
 
     _TRACK_TEMPLATE = """