From 9f46071958135b43b752246219503e30337749d0 Mon Sep 17 00:00:00 2001
From: Vo Minh Thu <vmt@openerp.com>
Date: Fri, 1 Jun 2012 17:45:44 +0200
Subject: [PATCH] [IMP] uninstall: added some docstrings.

bzr revid: vmt@openerp.com-20120601154544-e9a9cox7fcyd411m
---
 openerp/osv/orm.py                            | 11 +++++++++--
 openerp/tests/addons/test_uninstall/models.py |  4 ++++
 2 files changed, 13 insertions(+), 2 deletions(-)

diff --git a/openerp/osv/orm.py b/openerp/osv/orm.py
index 51485b83266..5fe926604d3 100644
--- a/openerp/osv/orm.py
+++ b/openerp/osv/orm.py
@@ -2740,7 +2740,11 @@ class BaseModel(object):
                               self._table, column['attname'])
 
     def _save_constraint(self, cr, constraint_name, type):
-        """ TODO """
+        """
+        Record the creation of a constraint for this model, to make it possible
+        to delete it later when the module is uninstalled. Type can be either
+        'f' or 'u' depending on the constraing being a foreign key or not.
+        """
         assert type in ('f', 'u')
         cr.execute("""
             SELECT 1 FROM ir_model_constraint, ir_module_module
@@ -2758,7 +2762,10 @@ class BaseModel(object):
                     (constraint_name, self._module, self._name, type))
 
     def _save_relation_table(self, cr, relation_table):
-        """ TODO """
+        """
+        Record the creation of a many2many for this model, to make it possible
+        to delete it later when the module is uninstalled.
+        """
         cr.execute("""
             SELECT 1 FROM ir_model_relation, ir_module_module
             WHERE ir_model_relation.module=ir_module_module.id
diff --git a/openerp/tests/addons/test_uninstall/models.py b/openerp/tests/addons/test_uninstall/models.py
index d7211dc2130..96a5800917d 100644
--- a/openerp/tests/addons/test_uninstall/models.py
+++ b/openerp/tests/addons/test_uninstall/models.py
@@ -4,6 +4,10 @@ from openerp.osv import fields
 from openerp.osv.orm import Model
 
 class test_uninstall_model(Model):
+    """
+    This model uses different types of columns to make it possible to test
+    the uninstall feature of OpenERP.
+    """
     _name = 'test_uninstall.model'
 
     _columns = {