Khushboo Bhatt(openerp) has proposed merging 
lp:~openerp-dev/openerp-india/payroll-india-trunk-doc-string-kbh into 
lp:~openerp-dev/openerp-india/payroll-india-trunk.

Requested reviews:
  OpenERP R&D Team (openerp-dev)

For more details, see:
https://code.launchpad.net/~openerp-dev/openerp-india/payroll-india-trunk-doc-string-kbh/+merge/110790

Hello,

 ==l10n_in_hr_payroll==

    I Have added doc string for methods and object.

Thank you,
KBH.
-- 
https://code.launchpad.net/~openerp-dev/openerp-india/payroll-india-trunk-doc-string-kbh/+merge/110790
Your team OpenERP R&D Team is requested to review the proposed merge of 
lp:~openerp-dev/openerp-india/payroll-india-trunk-doc-string-kbh into 
lp:~openerp-dev/openerp-india/payroll-india-trunk.
=== modified file 'l10n_in_hr_payroll/l10n_in_hr_payroll.py'
--- l10n_in_hr_payroll/l10n_in_hr_payroll.py	2012-06-15 12:29:01 +0000
+++ l10n_in_hr_payroll/l10n_in_hr_payroll.py	2012-06-18 11:52:25 +0000
@@ -31,6 +31,11 @@
 DATETIME_FORMAT = "%Y-%m-%d"
 
 class hr_contract(osv.osv):
+    """
+    Employee contract allows to add different values in fields.
+    Fields are used in salary rule computation.
+    """
+
     _inherit = 'hr.contract'
     _description = 'contract'
     
@@ -54,7 +59,11 @@
 
 
 class hr_employee(osv.osv):
-    
+    '''
+    Employee's Join date allows to compute total working 
+    experience of Employee and it is used to calculate Gratuity rule.
+    '''
+
     _inherit = 'hr.employee'
     _description = 'Employee'
 
@@ -128,6 +137,15 @@
     }
 
     def compute_advice(self, cr, uid, ids, context=None):
+        """
+        Advice - Create Advice lines in Payment Advice and 
+        compute Advice lines.
+        @param cr: the current row, from the database cursor,
+        @param uid: the current user’s ID for security checks,
+        @param ids: List of Advice’s IDs
+        @return: Advice lines
+        @param context: A standard dictionary for contextual values
+        """
         payslip_pool = self.pool.get('hr.payslip')
         advice_line_pool = self.pool.get('hr.payroll.advice.line')
         payslip_line_pool = self.pool.get('hr.payslip.line')
@@ -157,6 +175,14 @@
         return True
 
     def confirm_sheet(self, cr, uid, ids, context=None):
+        """
+        confirm Advice - confirmed Advice after computing Advice Lines..
+        @param cr: the current row, from the database cursor,
+        @param uid: the current user’s ID for security checks,
+        @param ids: List of confirm Advice’s IDs
+        @return: confirmed Advice lines and set sequence of Advice.
+        @param context: A standard dictionary for contextual values
+        """
         seq_obj = self.pool.get('ir.sequence')
         for advice in self.browse(cr, uid, ids, context=context):
             if not advice.line_ids:
@@ -169,9 +195,13 @@
         return True
 
     def set_to_draft(self, cr, uid, ids, context=None):
+        """Resets Advice as draft.
+        """
         return self.write(cr, uid, ids, {'state':'draft'}, context=context)
 
     def cancel_sheet(self, cr, uid, ids, context=None):
+        """Marks Advice as cancelled.
+        """
         return self.write(cr, uid, ids, {'state':'cancel'}, context=context)
 
     def onchange_company_id(self, cr, uid, ids, company_id=False, context=None):

_______________________________________________
Mailing list: https://launchpad.net/~openerp-dev-gtk
Post to     : [email protected]
Unsubscribe : https://launchpad.net/~openerp-dev-gtk
More help   : https://help.launchpad.net/ListHelp

Reply via email to