Merge lp:~numerigraphe/openobject-addons/trunk-stock-docstrings into lp:openobject-addons

[Numérigraphe]

More informative docstrings and comments in stock/stock.py

[Fabien (Open ERP) (fp-tinyerp)]

merged in trunk , thanks for the contribution.

=== modified file 'stock/stock.py'
--- stock/stock.py	2012-02-15 18:00:28 +0000
+++ stock/stock.py	2012-02-28 16:09:49 +0000
@@ -669,6 +669,7 @@
     ]
 
     def action_process(self, cr, uid, ids, context=None):
+        """Open the partial picking wizard"""
         if context is None: context = {}
         context = dict(context, active_ids=ids, active_model=self._name)
         partial_id = self.pool.get("stock.partial.picking").create(cr, uid, {}, context=context)
@@ -710,6 +711,7 @@
         return {}
 
     def action_explode(self, cr, uid, moves, context=None):
+        """Hook to allow other modules to split the moves of a picking."""
         return moves
 
     def action_confirm(self, cr, uid, ids, context=None):
@@ -844,14 +846,20 @@
     # TODO: change and create a move if not parents
     #
     def action_done(self, cr, uid, ids, context=None):
-        """ Changes picking state to done.
+        """Changes picking state to done.
+        
+        This method is called at the end of the workflow by the activity "done".
         @return: True
         """
         self.write(cr, uid, ids, {'state': 'done', 'date_done': time.strftime('%Y-%m-%d %H:%M:%S')})
         return True
 
     def action_move(self, cr, uid, ids, context=None):
-        """ Changes move state to assigned.
+        """Process the Stock Moves of the Picking
+        
+        This method is called by the workflow by the activity "move".
+        Normally that happens when the signal button_done is received (button 
+        "Done" pressed on a Picking view). 
         @return: True
         """
         for pick in self.browse(cr, uid, ids, context=context):
@@ -2367,6 +2375,7 @@
         return res
 
     # action_split function is not used anywhere
+    # FIXME: deprecate this method
     def action_split(self, cr, uid, ids, quantity, split_by_qty=1, prefix=False, with_lot=True, context=None):
         """ Split Stock Move lines into production lot which specified split by quantity.
         @param cr: the database cursor