From f2117bf48215482aa4b8efc8b96e37645c0bc726 Mon Sep 17 00:00:00 2001
From: "uco (OpenERP)" <uco@tinyerp.co.in>
Date: Mon, 5 Apr 2010 17:58:03 +0530
Subject: [PATCH] [ADD, IMP] mrp: Added doc strings in functions and classes.
 Improve spacing in docstrings of wizard files.

bzr revid: uco@tinyerp.co.in-20100405122803-lvkh410ncgj2tte6
---
 addons/mrp/mrp.py                             | 260 +++++++++++++++---
 addons/mrp/stock.py                           |  36 ++-
 addons/mrp/wizard/change_production_qty.py    |  35 +--
 addons/mrp/wizard/make_procurement_product.py |  54 ++--
 addons/mrp/wizard/mrp_price.py                |  15 +-
 addons/mrp/wizard/mrp_product_produce.py      |  32 +--
 addons/mrp/wizard/mrp_track_prod.py           |   9 +-
 addons/mrp/wizard/mrp_workcenter_load.py      |  15 +-
 addons/mrp/wizard/orderpoint_procurement.py   |  21 +-
 addons/mrp/wizard/schedulers_all.py           |  20 +-
 10 files changed, 337 insertions(+), 160 deletions(-)

diff --git a/addons/mrp/mrp.py b/addons/mrp/mrp.py
index a238658302c..9ca9fee3e91 100644
--- a/addons/mrp/mrp.py
+++ b/addons/mrp/mrp.py
@@ -65,6 +65,9 @@ mrp_workcenter()
 
 
 class mrp_property_group(osv.osv):
+    """
+    Group of mrp properties.
+    """
     _name = 'mrp.property.group'
     _description = 'Property Group'
     _columns = {
@@ -74,6 +77,9 @@ class mrp_property_group(osv.osv):
 mrp_property_group()
 
 class mrp_property(osv.osv):
+    """
+    Properties of mrp.
+    """
     _name = 'mrp.property'
     _description = 'Property'
     _columns = {
@@ -88,6 +94,9 @@ class mrp_property(osv.osv):
 mrp_property()
 
 class mrp_routing(osv.osv):
+    """
+    For specifying the routings of workcenters.
+    """
     _name = 'mrp.routing'
     _description = 'Routing'
     _columns = {
@@ -110,6 +119,9 @@ class mrp_routing(osv.osv):
 mrp_routing()
 
 class mrp_routing_workcenter(osv.osv):
+    """
+    Defines working cycles and hours of a workcenter using routings.
+    """
     _name = 'mrp.routing.workcenter'
     _description = 'Routing workcenter usage'
     _columns = {
@@ -131,19 +143,22 @@ class mrp_routing_workcenter(osv.osv):
 mrp_routing_workcenter()
 
 class mrp_bom(osv.osv):
+    """
+    Defines bills of material for a product.
+    """
     _name = 'mrp.bom'
     _description = 'Bills of Material'
+    
     def _child_compute(self, cr, uid, ids, name, arg, context={}):
-        """ 
-             @param self: The object pointer.
-             @param cr: A database cursor
-             @param uid: ID of the user currently logged in
-             @param ids: the ID of mrp.production object
-             @param name: name of the field
-             @param arg: user defined argument
-
-             @return:  True
-        
+        """ Gets child bom.
+        @param self: The object pointer
+        @param cr: The current row, from the database cursor,
+        @param uid: The current user ID for security checks
+        @param ids: List of selected IDs
+        @param name: Name of the field
+        @param arg: User defined argument
+        @param context: A standard dictionary for contextual values
+        @return:  Dictionary of values
         """  
         result = {}
         for bom in self.browse(cr, uid, ids, context=context):
@@ -158,7 +173,13 @@ class mrp_bom(osv.osv):
                     result[bom.id] += map(lambda x: x.id, bom2.bom_lines)                 
 
         return result
+    
     def _compute_type(self, cr, uid, ids, field_name, arg, context):
+        """ Sets particular method for the selected bom type.
+        @param field_name: Name of the field
+        @param arg: User defined argument
+        @return:  Dictionary of values
+        """  
         res = dict(map(lambda x: (x,''), ids))
         for line in self.browse(cr, uid, ids):
             if line.type=='phantom' and not line.bom_id:
@@ -172,6 +193,7 @@ class mrp_bom(osv.osv):
                 else:
                     res[line.id] = 'order'
         return res
+    
     _columns = {
         'name': fields.char('Name', size=64, required=True),
         'code': fields.char('Code', size=16),
@@ -234,6 +256,11 @@ class mrp_bom(osv.osv):
 
 
     def onchange_product_id(self, cr, uid, ids, product_id, name, context={}):
+        """ Changes UoM and name if product_id changes.
+        @param name: Name of the field
+        @param product_id: Changed product_id
+        @return:  Dictionary of changed values
+        """
         if product_id:
             prod=self.pool.get('product.product').browse(cr,uid,[product_id])[0]
             v = {'product_uom':prod.uom_id.id}
@@ -243,6 +270,12 @@ class mrp_bom(osv.osv):
         return {}
 
     def _bom_find(self, cr, uid, product_id, product_uom, properties=[]):
+        """ Finds BoM for particular product and product uom.
+        @param product_id: Selected product.
+        @param product_uom: Unit of measure of a product.
+        @param properties: List of related properties.
+        @return: False or BoM id.
+        """
         bom_result = False
         # Why searching on BoM without parent ?
         cr.execute('select id from mrp_bom where product_id=%s and bom_id is null order by sequence', (product_id,))
@@ -260,6 +293,15 @@ class mrp_bom(osv.osv):
         return result
 
     def _bom_explode(self, cr, uid, bom, factor, properties, addthis=False, level=0):
+        """ Finds Products and Workcenters for related BoM for manufacturing order.
+        @param bom: BoM of particular product.
+        @param factor: Factor of product UoM.
+        @param properties: A dictionary for contextual values.
+        @param addthis: If BoM found then True else False.
+        @param level: Depth level to find BoM lines starts from 10.
+        @return: result: List of dictionaries containing product details.
+                 result2: List of dictionaries containing workcenter details.
+        """
         factor = factor / (bom.product_efficiency or 1.0)
         factor = rounding(factor, bom.product_rounding)
         if factor<bom.product_rounding:
@@ -307,6 +349,9 @@ class mrp_bom(osv.osv):
         return result, result2
 
     def set_indices(self, cr, uid, ids, context = {}):
+        """ Sets Indices.
+        @return: True
+        """
         if not ids or (ids and not ids[0]):
             return True
         res = self.read(cr, uid, ids, ['revision_ids', 'revision_type'])
@@ -389,11 +434,19 @@ class one2many_domain(fields.one2many):
         return res
 
 class mrp_production(osv.osv):
+    """
+    Production Orders / Manufacturing Orders
+    """
     _name = 'mrp.production'
     _description = 'Production'
     _date_name  = 'date_planned'    
 
     def _production_calc(self, cr, uid, ids, prop, unknow_none, context={}):
+        """ Calculates total hours and total no. of cycles for a production order.
+        @param prop: 
+        @param unknow_none: 
+        @return: Dictionary of values.
+        """
         result = {}
         for prod in self.browse(cr, uid, ids, context=context):
             result[prod.id] = {
@@ -406,18 +459,33 @@ class mrp_production(osv.osv):
         return result
 
     def _production_date_end(self, cr, uid, ids, prop, unknow_none, context={}):
+        """ Finds production end date.
+        @param prop: Name of field.
+        @param unknow_none: 
+        @return: Dictionary of values.
+        """
         result = {}
         for prod in self.browse(cr, uid, ids, context=context):
             result[prod.id] = prod.date_planned
         return result
 
     def _production_date(self, cr, uid, ids, prop, unknow_none, context={}):
+        """ Finds production planned date.
+        @param prop: Name of field.
+        @param unknow_none:  
+        @return: Dictionary of values.
+        """
         result = {}
         for prod in self.browse(cr, uid, ids, context=context):
             result[prod.id] = prod.date_planned[:10]
         return result
 
     def _ref_calc(self, cr, uid, ids, field_names=None, arg=False, context={}):
+        """ Finds reference sale order for production order.
+        @param field_names: Names of fields.
+        @param arg: User defined arguments
+        @return: Dictionary of values.
+        """
         res = {}
         for f in field_names:
             for order_id in ids:
@@ -499,6 +567,11 @@ class mrp_production(osv.osv):
         return super(mrp_production, self).copy(cr, uid, id, default, context)
 
     def location_id_change(self, cr, uid, ids, src, dest, context={}):
+        """ Changes destination location if source location is changed.
+        @param src: Source location id.
+        @param dest: Destination location id.
+        @return: Dictionary of values.
+        """
         if dest:
             return {}
         if src:
@@ -506,6 +579,10 @@ class mrp_production(osv.osv):
         return {}
 
     def product_id_change(self, cr, uid, ids, product):
+        """ Finds UoM of changed product.
+        @param product: Id of changed product.
+        @return: Dictionary of values.
+        """
         if not product:
             return {}
         res = self.pool.get('product.product').read(cr, uid, [product], ['uom_id'])[0]
@@ -514,6 +591,10 @@ class mrp_production(osv.osv):
         return {'value':result}
 
     def bom_id_change(self, cr, uid, ids, product):
+        """ Finds routing for changed BoM.
+        @param product: Id of product.
+        @return: Dictionary of values.
+        """
         if not product:
             return {}
         res = self.pool.get('mrp.bom').read(cr, uid, [product], ['routing_id'])[0]
@@ -522,10 +603,17 @@ class mrp_production(osv.osv):
         return {'value':result}
 
     def action_picking_except(self, cr, uid, ids):
+        """ Changes the state to Exception.
+        @return: True 
+        """
         self.write(cr, uid, ids, {'state':'picking_except'})
         return True
 
     def action_compute(self, cr, uid, ids, properties=[]):
+        """ Computes bills of material of a product.
+        @param properties: List containing dictionaries of properties.
+        @return: No. of products.
+        """
         results = []
         bom_obj = self.pool.get('mrp.bom')
         prod_line_obj = self.pool.get('mrp.production.product.line')
@@ -561,6 +649,9 @@ class mrp_production(osv.osv):
         return len(results)
 
     def action_cancel(self, cr, uid, ids):
+        """ Cancels the production order and related stock moves.
+        @return: True
+        """
         move_obj = self.pool.get('stock.move')
         for production in self.browse(cr, uid, ids):
             if production.move_created_ids:
@@ -572,6 +663,9 @@ class mrp_production(osv.osv):
     #XXX: may be a bug here; lot_lines are unreserved for a few seconds;
     #     between the end of the picking list and the call to this function
     def action_ready(self, cr, uid, ids):
+        """ Changes the production state to Ready and location id of stock move.
+        @return: True
+        """
         move_obj = self.pool.get('stock.move')
         self.write(cr, uid, ids, {'state':'ready'})
         for production in self.browse(cr, uid, ids):
@@ -581,11 +675,17 @@ class mrp_production(osv.osv):
         return True
 
     def action_production_end(self, cr, uid, ids):
+        """ Changes production state to Finish and writes finished date.
+        @return: True
+        """
         for production in self.browse(cr, uid, ids):
             self._costs_generate(cr, uid, production)
         return self.write(cr,  uid, ids, {'state': 'done', 'date_finnished': time.strftime('%Y-%m-%d %H:%M:%S')})
 
     def test_production_done(self, cr, uid, ids):
+        """ Tests whether production is done or not.
+        @return: True or False
+        """
         res = True
         for production in self.browse(cr, uid, ids):            
             if production.move_lines:                
@@ -596,21 +696,14 @@ class mrp_production(osv.osv):
         return res
 
     def action_produce(self, cr, uid, production_id, production_qty, production_mode, context=None):
-        """ 
-            To produce final product base on production mode (consume/consume&produce).
-            If Production mode is consume, all stock move lines of raw materials will be done/consumed.
-            If Production mode is consume & produce, all stock move lines of raw materials will be done/consumed
-            and stock move lines of final product will be also done/produced.
-        
-             @param self: The object pointer.
-             @param cr: A database cursor
-             @param uid: ID of the user currently logged in
-             @param production_id: the ID of mrp.production object
-             @param production_qty: specify qty to produce
-             @param production_mode: specify production mode (consume/consume&produce).
-
-             @return:  True
-        
+        """ To produce final product base on production mode (consume/consume&produce).
+        If Production mode is consume, all stock move lines of raw materials will be done/consumed.
+        If Production mode is consume & produce, all stock move lines of raw materials will be done/consumed
+        and stock move lines of final product will be also done/produced.
+        @param production_id: the ID of mrp.production object
+        @param production_qty: specify qty to produce
+        @param production_mode: specify production mode (consume/consume&produce).
+        @return: True
         """              
         stock_mov_obj = self.pool.get('stock.move')
         production = self.browse(cr, uid, production_id)
@@ -679,6 +772,10 @@ class mrp_production(osv.osv):
         return True
 
     def _costs_generate(self, cr, uid, production):
+        """ Calculates total costs at the end of the production.
+        @param production: Id of production order.
+        @return: Calculated amount.
+        """
         amount = 0.0
         analytic_line_obj = self.pool.get('account.analytic.line')
         for wc_line in production.workcenter_lines:
@@ -712,11 +809,17 @@ class mrp_production(osv.osv):
         return amount
 
     def action_in_production(self, cr, uid, ids):
+        """ Changes state to In Production and writes starting date.
+        @return: True 
+        """
         move_ids = []        
         self.write(cr, uid, ids, {'state': 'in_production','date_start':time.strftime('%Y-%m-%d %H:%M:%S')})
         return True
 
     def test_if_product(self, cr, uid, ids):
+        """
+        @return: True or False
+        """
         res = True
         for production in self.browse(cr, uid, ids):
             if not production.product_lines:
@@ -728,6 +831,9 @@ class mrp_production(osv.osv):
         return True
 
     def action_confirm(self, cr, uid, ids):
+        """ Confirms production order.
+        @return: Newly generated picking Id.
+        """
         picking_id=False
         proc_ids = []
         seq_obj = self.pool.get('ir.sequence')
@@ -835,6 +941,10 @@ class mrp_production(osv.osv):
         return picking_id
 
     def force_production(self, cr, uid, ids, *args):
+        """ Assigns products.
+        @param *args: Arguments
+        @return: True
+        """
         pick_obj = self.pool.get('stock.picking')
         pick_obj.force_assign(cr, uid, [prod.picking_id.id for prod in self.browse(cr, uid, ids)])
         return True
@@ -882,6 +992,9 @@ mrp_production_product_line()
 #     then wizard for picking lists & move
 #
 class mrp_procurement(osv.osv):
+    """
+    Procument Orders / Requisitions
+    """
     _name = "mrp.procurement"
     _description = "Procurement"
     _order = 'priority,date_planned'
@@ -948,6 +1061,10 @@ class mrp_procurement(osv.osv):
         return osv.osv.unlink(self, cr, uid, unlink_ids, context=context)
 
     def onchange_product_id(self, cr, uid, ids, product_id, context={}):
+        """ Finds UoM and UoS of changed product.
+        @param product_id: Changed id of product.
+        @return: Dictionary of values.
+        """
         if product_id:
             w=self.pool.get('product.product').browse(cr,uid,product_id, context)
             v = {
@@ -958,12 +1075,18 @@ class mrp_procurement(osv.osv):
         return {}
 
     def check_product(self, cr, uid, ids):
+        """ Checks product type.
+        @return: True or False 
+        """
         for procurement in self.browse(cr, uid, ids):
             if procurement.product_id.type in ('product', 'consu'):
                 return True
         return False
 
     def check_move_cancel(self, cr, uid, ids, context={}):
+        """ Checks if move is cancelled or not.
+        @return: True or False. 
+        """
         res = True
         ok = False
         for procurement in self.browse(cr, uid, ids, context):
@@ -974,6 +1097,9 @@ class mrp_procurement(osv.osv):
         return res and ok
 
     def check_move_done(self, cr, uid, ids, context={}):
+        """ Checks if move is done or not.
+        @return: True or False. 
+        """
         res = True
         for proc in self.browse(cr, uid, ids, context):
             if proc.move_id:
@@ -986,12 +1112,20 @@ class mrp_procurement(osv.osv):
     # for computing their own purpose
     #
     def _quantity_compute_get(self, cr, uid, proc, context={}):
+        """ Finds sold quantity of product.
+        @param proc: Current procurement.
+        @return: Quantity or False.
+        """
         if proc.product_id.type=='product':
             if proc.move_id.product_uos:
                 return proc.move_id.product_uos_qty
         return False
 
     def _uom_compute_get(self, cr, uid, proc, context={}):
+        """ Finds UoS if product is Stockable Product. 
+        @param proc: Current procurement.
+        @return: UoS or False.
+        """
         if proc.product_id.type=='product':
             if proc.move_id.product_uos:
                 return proc.move_id.product_uos.id
@@ -1002,6 +1136,9 @@ class mrp_procurement(osv.osv):
     # different from the planned quantity
     #
     def quantity_get(self, cr, uid, id, context={}):
+        """ Finds quantity of product used in procurement.
+        @return: Quantity of product. 
+        """
         proc = self.browse(cr, uid, id, context)
         result = self._quantity_compute_get(cr, uid, proc, context)
         if not result:
@@ -1009,6 +1146,9 @@ class mrp_procurement(osv.osv):
         return result
 
     def uom_get(self, cr, uid, id, context=None):
+        """ Finds UoM of product used in procurement.
+        @return: UoM of product. 
+        """
         proc = self.browse(cr, uid, id, context)
         result = self._uom_compute_get(cr, uid, proc, context)
         if not result:
@@ -1016,6 +1156,9 @@ class mrp_procurement(osv.osv):
         return result
 
     def check_waiting(self, cr, uid, ids, context=[]):
+        """ Checks state of move.
+        @return: True or False 
+        """
         for procurement in self.browse(cr, uid, ids, context=context):
             if procurement.move_id and procurement.move_id.state=='auto':
                 return True
@@ -1025,6 +1168,10 @@ class mrp_procurement(osv.osv):
         return True
 
     def check_produce_product(self, cr, uid, procurement, context=[]):
+        """ Finds BoM of a product if not found writes exception message.
+        @param procurement: Current procurement.
+        @return: True or False.
+        """
         properties = [x.id for x in procurement.property_ids]
         bom_id = self.pool.get('mrp.bom')._bom_find(cr, uid, procurement.product_id.id, procurement.product_uom.id, properties)
         if not bom_id:
@@ -1033,6 +1180,9 @@ class mrp_procurement(osv.osv):
         return True
 
     def check_make_to_stock(self, cr, uid, ids, context={}):
+        """ Checks product type.
+        @return: True or False 
+        """
         ok = True
         for procurement in self.browse(cr, uid, ids, context=context):
             if procurement.product_id.type=='service':
@@ -1042,6 +1192,9 @@ class mrp_procurement(osv.osv):
         return ok
 
     def check_produce(self, cr, uid, ids, context={}):
+        """ Checks product type.
+        @return: True or Product Id.
+        """
         res = True
         user = self.pool.get('res.users').browse(cr, uid, uid)
         for procurement in self.browse(cr, uid, ids):
@@ -1061,6 +1214,9 @@ class mrp_procurement(osv.osv):
         return res
 
     def check_buy(self, cr, uid, ids):
+        """ Checks product type.
+        @return: True or Product Id.
+        """
         user = self.pool.get('res.users').browse(cr, uid, uid)
         partner_obj = self.pool.get('res.partner')
         for procurement in self.browse(cr, uid, ids):
@@ -1080,12 +1236,18 @@ class mrp_procurement(osv.osv):
         return True
 
     def test_cancel(self, cr, uid, ids):
+        """ Tests whether state of move is cancelled or not. 
+        @return: True or False
+        """
         for record in self.browse(cr, uid, ids):
             if record.move_id and record.move_id.state=='cancel':
                 return True
         return False
 
     def action_confirm(self, cr, uid, ids, context={}):
+        """ Confirms procurement and writes exception message if any.
+        @return: True
+        """
         move_obj = self.pool.get('stock.move')
         for procurement in self.browse(cr, uid, ids):
             if procurement.product_qty <= 0.00:
@@ -1115,6 +1277,9 @@ class mrp_procurement(osv.osv):
         return True
 
     def action_move_assigned(self, cr, uid, ids, context={}):
+        """ Changes procurement state to Running and writes message.
+        @return: True 
+        """
         self.write(cr, uid, ids, {'state':'running','message':_('from stock: products assigned.')})
         return True
 
@@ -1122,6 +1287,10 @@ class mrp_procurement(osv.osv):
         return True
 
     def _check_make_to_stock_product(self, cr, uid, procurement, context={}):
+        """ Checks procurement move state.
+        @param procurement: Current procurement.
+        @return: True or move id.
+        """
         ok = True
         if procurement.move_id:
             id = procurement.move_id.id
@@ -1133,24 +1302,24 @@ class mrp_procurement(osv.osv):
         return ok
 
     def action_produce_assign_service(self, cr, uid, ids, context={}):
+        """ Changes procurement state to Running.
+        @return: True 
+        """
         for procurement in self.browse(cr, uid, ids):
             self.write(cr, uid, [procurement.id], {'state':'running'})
         return True
 
     def action_produce_assign_product(self, cr, uid, ids, context={}):
-        """
-        This is action which call from workflow to assign production order to procuments
-        @return  : True
+        """ This is action which call from workflow to assign production order to procurements
+        @return: True
         """
         res = self.make_mo(cr, uid, ids, context=context)
         res = res.values()
         return len(res) and res[0] or 0 #TO CHECK: why workflow is generated error if return not integer value
 
     def make_mo(self, cr, uid, ids, context={}):
-        """
-        Make Manufecturing(production) order from procurement
-        
-        @return : New created Production Orders procurement wise 
+        """ Make Manufecturing(production) order from procurement
+        @return: New created Production Orders procurement wise 
         """
         res = {}
         company = self.pool.get('res.users').browse(cr, uid, uid, context).company_id
@@ -1186,19 +1355,16 @@ class mrp_procurement(osv.osv):
         return res
     
     def action_po_assign(self, cr, uid, ids, context={}):
-        """
-        This is action which call from workflow to assign purchase order to procuments
-        @return  : True
+        """ This is action which call from workflow to assign purchase order to procuments
+        @return: True
         """
         res = self.make_po(cr, uid, ids, context=context)
         res = res.values()
         return len(res) and res[0] or 0 #TO CHECK: why workflow is generated error if return not integer value
 
     def make_po(self, cr, uid, ids, context={}):
-        """
-        Make purchase order from procurement
-        
-        @return : New created Purchase Orders procurement wise
+        """ Make purchase order from procurement
+        @return: New created Purchase Orders procurement wise
         """
         res = {}
         company = self.pool.get('res.users').browse(cr, uid, uid, context).company_id
@@ -1263,6 +1429,9 @@ class mrp_procurement(osv.osv):
         return res
 
     def action_cancel(self, cr, uid, ids):
+        """ Cancels procurement and writes move state to Assigned.
+        @return: True 
+        """
         todo = []
         todo2 = []
         move_obj = self.pool.get('stock.move')
@@ -1287,6 +1456,9 @@ class mrp_procurement(osv.osv):
         return self.check_move_done(cr, uid, ids)
 
     def action_check(self, cr, uid, ids):
+        """ Checks procurement move state whether assigned or done. 
+        @return: True 
+        """
         ok = False
         for procurement in self.browse(cr, uid, ids):
             if procurement.move_id.state=='assigned' or procurement.move_id.state=='done':
@@ -1295,10 +1467,16 @@ class mrp_procurement(osv.osv):
         return ok
 
     def action_ready(self, cr, uid, ids):
+        """ Changes procurement state to Ready.
+        @return: True 
+        """
         res = self.write(cr, uid, ids, {'state':'ready'})
         return res
 
     def action_done(self, cr, uid, ids):
+        """ Changes procurement state to Done and writes Closed date.
+        @return: True 
+        """
         move_obj = self.pool.get('stock.move')
         for procurement in self.browse(cr, uid, ids):
             if procurement.move_id:
@@ -1311,8 +1489,8 @@ class mrp_procurement(osv.osv):
         return res
 
     def run_scheduler(self, cr, uid, automatic=False, use_new_cursor=False, context=None):
-        '''
-        use_new_cursor: False or the dbname
+        ''' Runs through scheduler.
+        @param use_new_cursor: False or the dbname
         '''
         if not context:
             context={}
diff --git a/addons/mrp/stock.py b/addons/mrp/stock.py
index 4ddfddf6d90..d395214b87a 100644
--- a/addons/mrp/stock.py
+++ b/addons/mrp/stock.py
@@ -29,6 +29,9 @@ import time
 
 
 class stock_warehouse_orderpoint(osv.osv):
+    """
+    Defines Minimum stock rules.
+    """
     _name = "stock.warehouse.orderpoint"
     _description = "Orderpoint minimum rule"
     _columns = {
@@ -59,12 +62,20 @@ class stock_warehouse_orderpoint(osv.osv):
         'company_id': lambda self,cr,uid,c: self.pool.get('res.company')._company_default_get(cr, uid, 'stock.warehouse.orderpoint', context=c)
     }
     def onchange_warehouse_id(self, cr, uid, ids, warehouse_id, context={}):
+        """ Finds location id for changed warehouse.
+        @param warehouse_id: Changed id of warehouse.
+        @return: Dictionary of values.
+        """
         if warehouse_id:
             w=self.pool.get('stock.warehouse').browse(cr,uid,warehouse_id, context)
             v = {'location_id':w.lot_stock_id.id}
             return {'value': v}
         return {}
     def onchange_product_id(self, cr, uid, ids, product_id, context={}):
+        """ Finds UoM for changed product.
+        @param product_id: Changed id of product.
+        @return: Dictionary of values.
+        """
         if product_id:
             prod=self.pool.get('product.product').browse(cr,uid,product_id)
             v = {'product_uom':prod.uom_id.id}
@@ -91,6 +102,10 @@ class StockMove(osv.osv):
         return super(StockMove, self).copy(cr, uid, id, default, context)
 
     def _action_explode(self, cr, uid, move, context={}):
+        """ Explodes pickings.
+        @param move: Stock moves
+        @return: True
+        """
         if move.product_id.supply_method=='produce' and move.product_id.procure_method=='make_to_order':
             bis = self.pool.get('mrp.bom').search(cr, uid, [
                 ('product_id','=',move.product_id.id),
@@ -151,7 +166,12 @@ class StockMove(osv.osv):
         return True
     
     
-    def action_consume(self, cr, uid, ids, product_qty, location_id=False, context=None):        
+    def action_consume(self, cr, uid, ids, product_qty, location_id=False, context=None): 
+        """ Consumed product with specific quatity from specific source location.
+        @param product_qty: Consumed product quantity
+        @param location_id: Source location
+        @return: Consumed lines
+        """       
         res = []
         production_obj = self.pool.get('mrp.production')
         wf_service = netsvc.LocalService("workflow")
@@ -168,6 +188,11 @@ class StockMove(osv.osv):
         return res
     
     def action_scrap(self, cr, uid, ids, product_qty, location_id, context=None):
+        """ Move the scrap/damaged product into scrap location
+        @param product_qty: Scraped product quantity
+        @param location_id: Scrap location
+        @return: Scraped lines
+        """  
         res = []
         production_obj = self.pool.get('mrp.production')
         wf_service = netsvc.LocalService("workflow")
@@ -202,6 +227,11 @@ class StockPicking(osv.osv):
     # Explode picking by replacing phantom BoMs
     #
     def action_explode(self, cr, uid, picks, *args):
+        """ Explodes picking by replacing phantom BoMs
+        @param picks: Picking ids. 
+        @param *args: Arguments
+        @return: Picking ids.
+        """  
         for move in self.pool.get('stock.move').browse(cr, uid, picks):
             self.pool.get('stock.move')._action_explode(cr, uid, move)
         return picks
@@ -212,6 +242,10 @@ StockPicking()
 class spilt_in_production_lot(osv.osv_memory):
     _inherit = "stock.move.split"
     def split(self, cr, uid, ids, move_ids, context=None):
+        """ Splits move lines into given quantities.
+        @param move_ids: Stock moves.
+        @return: List of new moves.
+        """  
         production_obj = self.pool.get('mrp.production')
         move_obj = self.pool.get('stock.move')  
         res = []      
diff --git a/addons/mrp/wizard/change_production_qty.py b/addons/mrp/wizard/change_production_qty.py
index 7f1496dd6a1..5f7aa0754e1 100644
--- a/addons/mrp/wizard/change_production_qty.py
+++ b/addons/mrp/wizard/change_production_qty.py
@@ -35,17 +35,13 @@ class change_production_qty(osv.osv_memory):
     }
 
     def default_get(self, cr, uid, fields, context):
-        """ 
-             To get default values for the object.
-            
-             @param self: The object pointer.
-             @param cr: A database cursor
-             @param uid: ID of the user currently logged in
-             @param fields: List of fields for which we want default values 
-             @param context: A standard dictionary 
-             
-             @return: A dictionary which of fields with values. 
-        
+        """ To get default values for the object.
+        @param self: The object pointer.
+        @param cr: A database cursor
+        @param uid: ID of the user currently logged in
+        @param fields: List of fields for which we want default values 
+        @param context: A standard dictionary 
+        @return: A dictionary which of fields with values. 
         """        
         res = super(change_production_qty, self).default_get(cr, uid, fields, context=context)        
         prod_obj = self.pool.get('mrp.production')
@@ -56,16 +52,13 @@ class change_production_qty(osv.osv_memory):
         
     def change_prod_qty(self, cr, uid, ids, context):
         """ 
-             Changes the Quantity of Product.
-            
-             @param self: The object pointer.
-             @param cr: A database cursor
-             @param uid: ID of the user currently logged in
-             @param ids: List of IDs selected 
-             @param context: A standard dictionary 
-             
-             @return:  
-        
+        Changes the Quantity of Product.
+        @param self: The object pointer.
+        @param cr: A database cursor
+        @param uid: ID of the user currently logged in
+        @param ids: List of IDs selected 
+        @param context: A standard dictionary 
+        @return:  
         """
         record_id = context and context.get('active_id',False)
         assert record_id, _('Active Id is not found')
diff --git a/addons/mrp/wizard/make_procurement_product.py b/addons/mrp/wizard/make_procurement_product.py
index a549d9f24b2..a2dd62327bb 100644
--- a/addons/mrp/wizard/make_procurement_product.py
+++ b/addons/mrp/wizard/make_procurement_product.py
@@ -29,17 +29,13 @@ class make_procurement(osv.osv_memory):
     _description = 'Make Procurements'
     
     def onchange_product_id(self, cr, uid, ids, prod_id):
-        """ 
-             On Change of Product ID getting the value of related UoM.
-        
-             @param self: The object pointer.
-             @param cr: A database cursor
-             @param uid: ID of the user currently logged in
-             @param ids: List of IDs selected 
-             @param prod_id: Changed ID of Product 
-             
-             @return: A dictionary which gives the UoM of the changed Product 
-        
+        """ On Change of Product ID getting the value of related UoM.
+         @param self: The object pointer.
+         @param cr: A database cursor
+         @param uid: ID of the user currently logged in
+         @param ids: List of IDs selected 
+         @param prod_id: Changed ID of Product 
+         @return: A dictionary which gives the UoM of the changed Product 
         """
         product = self.pool.get('product.product').browse(cr, uid, prod_id)
         return {'value': {'uom_id': product.uom_id.id}}
@@ -58,17 +54,13 @@ class make_procurement(osv.osv_memory):
     }
     
     def make_procurement(self, cr, uid, ids, context=None):
-        """ 
-             Creates procurement order for selected product.
-        
-             @param self: The object pointer.
-             @param cr: A database cursor
-             @param uid: ID of the user currently logged in
-             @param ids: List of IDs selected 
-             @param context: A standard dictionary 
-             
-             @return: A dictionary which loads Procurement form view. 
-        
+        """ Creates procurement order for selected product.
+        @param self: The object pointer.
+        @param cr: A database cursor
+        @param uid: ID of the user currently logged in
+        @param ids: List of IDs selected 
+        @param context: A standard dictionary 
+        @return: A dictionary which loads Procurement form view. 
         """
         user = self.pool.get('res.users').browse(cr, uid, uid, context).login
         wh_obj = self.pool.get('stock.warehouse')
@@ -109,17 +101,13 @@ class make_procurement(osv.osv_memory):
          }
     
     def default_get(self, cr, uid, fields, context=None):
-        """ 
-             To get default values for the object.
-            
-             @param self: The object pointer.
-             @param cr: A database cursor
-             @param uid: ID of the user currently logged in
-             @param fields: List of fields for which we want default values 
-             @param context: A standard dictionary 
-             
-             @return: A dictionary which of fields with values. 
-        
+        """ To get default values for the object.
+        @param self: The object pointer.
+        @param cr: A database cursor
+        @param uid: ID of the user currently logged in
+        @param fields: List of fields for which we want default values 
+        @param context: A standard dictionary 
+        @return: A dictionary which of fields with values. 
         """
         record_id = context and context.get('active_id', False) or False
 
diff --git a/addons/mrp/wizard/mrp_price.py b/addons/mrp/wizard/mrp_price.py
index 5d3c16cbaa5..55393a4371c 100644
--- a/addons/mrp/wizard/mrp_price.py
+++ b/addons/mrp/wizard/mrp_price.py
@@ -29,15 +29,12 @@ class mrp_price(osv.osv_memory):
     }
     
     def print_report(self, cr, uid, ids, context=None):
-        """ 
-             To print the report of Product cost structure
-                        
-             @param self: The object pointer.
-             @param cr: A database cursor
-             @param uid: ID of the user currently logged in
-             @param context: A standard dictionary 
-             
-             @return : Report
+        """ To print the report of Product cost structure
+        @param self: The object pointer.
+        @param cr: A database cursor
+        @param uid: ID of the user currently logged in
+        @param context: A standard dictionary 
+        @return : Report
         """        
         datas = {'ids' : context.get('active_ids',[])}
         res = self.read(cr, uid, ids, ['number'])
diff --git a/addons/mrp/wizard/mrp_product_produce.py b/addons/mrp/wizard/mrp_product_produce.py
index 7c77dfdee94..b64567a407a 100644
--- a/addons/mrp/wizard/mrp_product_produce.py
+++ b/addons/mrp/wizard/mrp_product_produce.py
@@ -34,15 +34,12 @@ class mrp_product_produce(osv.osv_memory):
     }
 
     def _get_product_qty(self, cr, uid, context):
-        """ 
-             To obtain product quantity
-        
-             @param self: The object pointer.
-             @param cr: A database cursor
-             @param uid: ID of the user currently logged in
-             @param context: A standard dictionary
-             @return: quantity 
-        
+        """ To obtain product quantity
+        @param self: The object pointer.
+        @param cr: A database cursor
+        @param uid: ID of the user currently logged in
+        @param context: A standard dictionary
+        @return: Quantity 
         """        
         prod = self.pool.get('mrp.production').browse(cr, uid, 
                                 context['active_id'], context=context)
@@ -57,16 +54,13 @@ class mrp_product_produce(osv.osv_memory):
                  }
 
     def do_produce(self, cr, uid, ids, context={}):
-        """ 
-             To check the product type
-        
-             @param self: The object pointer.
-             @param cr: A database cursor
-             @param uid: ID of the user currently logged in
-             @param ids: the ID or list of IDs if we want more than one 
-             @param context: A standard dictionary
-             @return:  
-        
+        """ To check the product type
+        @param self: The object pointer.
+        @param cr: A database cursor
+        @param uid: ID of the user currently logged in
+        @param ids: the ID or list of IDs if we want more than one 
+        @param context: A standard dictionary
+        @return:  
         """               
         prod_obj = self.pool.get('mrp.production')
         move_ids = context['active_ids']
diff --git a/addons/mrp/wizard/mrp_track_prod.py b/addons/mrp/wizard/mrp_track_prod.py
index 52e5508317a..11e1ec32ec6 100644
--- a/addons/mrp/wizard/mrp_track_prod.py
+++ b/addons/mrp/wizard/mrp_track_prod.py
@@ -26,8 +26,7 @@ class mrp_track_move(osv.osv_memory):
     _description = 'Production Track'
             
     def view_init(self, cr, uid, fields_list, context=None):
-        """ 
-         Creates view dynamically and adding fields at runtime.
+        """ Creates view dynamically and adding fields at runtime.
          @param self: The object pointer.
          @param cr: A database cursor
          @param uid: ID of the user currently logged in
@@ -48,8 +47,7 @@ class mrp_track_move(osv.osv_memory):
         return res
     
     def fields_view_get(self, cr, uid, view_id=None, view_type='form', context=None, toolbar=False, submenu=False):
-        """ 
-         Changes the view dynamically
+        """ Changes the view dynamically
          @param self: The object pointer.
          @param cr: A database cursor
          @param uid: ID of the user currently logged in
@@ -88,8 +86,7 @@ class mrp_track_move(osv.osv_memory):
         return res
     
     def track_lines(self, cr, uid, ids, context):
-        """
-         Tracks Finished products and splits products to finish lines.
+        """ Tracks Finished products and splits products to finish lines.
          @param self: The object pointer.
          @param cr: A database cursor
          @param uid: ID of the user currently logged in
diff --git a/addons/mrp/wizard/mrp_workcenter_load.py b/addons/mrp/wizard/mrp_workcenter_load.py
index 1b5478dcbeb..db08b170ee1 100644
--- a/addons/mrp/wizard/mrp_workcenter_load.py
+++ b/addons/mrp/wizard/mrp_workcenter_load.py
@@ -31,15 +31,12 @@ class mrp_workcenter_load(osv.osv_memory):
     }
 
     def print_report(self, cr, uid, ids, context=None):
-        """ 
-             To print the report of Work Center Load
-                        
-             @param self: The object pointer.
-             @param cr: A database cursor
-             @param uid: ID of the user currently logged in
-             @param context: A standard dictionary 
-             
-             @return : Report
+        """ To print the report of Work Center Load
+        @param self: The object pointer.
+        @param cr: A database cursor
+        @param uid: ID of the user currently logged in
+        @param context: A standard dictionary 
+        @return : Report
         """        
         datas = {'ids' : context.get('active_ids',[])}
         res = self.read(cr, uid, ids, ['time_unit','measure_unit'])
diff --git a/addons/mrp/wizard/orderpoint_procurement.py b/addons/mrp/wizard/orderpoint_procurement.py
index 731c3fca440..56302660939 100644
--- a/addons/mrp/wizard/orderpoint_procurement.py
+++ b/addons/mrp/wizard/orderpoint_procurement.py
@@ -41,11 +41,11 @@ class procurement_compute(osv.osv_memory):
     
     def _procure_calculation_orderpoint(self, cr, uid, ids, context):
         """ 
-             @param self: The object pointer.
-             @param cr: A database cursor
-             @param uid: ID of the user currently logged in
-             @param ids: List of IDs selected 
-             @param context: A standard dictionary 
+        @param self: The object pointer.
+        @param cr: A database cursor
+        @param uid: ID of the user currently logged in
+        @param ids: List of IDs selected 
+        @param context: A standard dictionary 
         """        
         proc_obj = self.pool.get('mrp.procurement')
         for proc in self.browse(cr, uid, ids):
@@ -55,12 +55,11 @@ class procurement_compute(osv.osv_memory):
     
     def procure_calculation(self, cr, uid, ids, context):
         """ 
-             @param self: The object pointer.
-             @param cr: A database cursor
-             @param uid: ID of the user currently logged in
-             @param ids: List of IDs selected 
-             @param context: A standard dictionary 
-        
+        @param self: The object pointer.
+        @param cr: A database cursor
+        @param uid: ID of the user currently logged in
+        @param ids: List of IDs selected 
+        @param context: A standard dictionary 
         """
         threaded_calculation = threading.Thread(target=self._procure_calculation_orderpoint, args=(cr, uid, ids, context))
         threaded_calculation.start()
diff --git a/addons/mrp/wizard/schedulers_all.py b/addons/mrp/wizard/schedulers_all.py
index 62497564905..ad67b1330d0 100644
--- a/addons/mrp/wizard/schedulers_all.py
+++ b/addons/mrp/wizard/schedulers_all.py
@@ -37,11 +37,11 @@ class procurement_compute(osv.osv_memory):
     
     def _procure_calculation_all(self, cr, uid, ids, context):
         """ 
-             @param self: The object pointer.
-             @param cr: A database cursor
-             @param uid: ID of the user currently logged in
-             @param ids: List of IDs selected 
-             @param context: A standard dictionary 
+        @param self: The object pointer.
+        @param cr: A database cursor
+        @param uid: ID of the user currently logged in
+        @param ids: List of IDs selected 
+        @param context: A standard dictionary 
         """
         proc_obj = self.pool.get('mrp.procurement')
         for proc in self.browse(cr, uid, ids):
@@ -51,11 +51,11 @@ class procurement_compute(osv.osv_memory):
     
     def procure_calculation(self, cr, uid, ids, context):
         """ 
-             @param self: The object pointer.
-             @param cr: A database cursor
-             @param uid: ID of the user currently logged in
-             @param ids: List of IDs selected 
-             @param context: A standard dictionary 
+        @param self: The object pointer.
+        @param cr: A database cursor
+        @param uid: ID of the user currently logged in
+        @param ids: List of IDs selected 
+        @param context: A standard dictionary 
         """
         threaded_calculation = threading.Thread(target=self._procure_calculation_all, args=(cr, uid, ids, context))
         threaded_calculation.start()