odoo
/
odoo
2
0
Fork 0
Code Pull Requests Releases Activity

[FIX] Model.import_data docstring: cleanup + clear RST warnings for autodoc 

The pipe character is taken as an inline substitution
marker, and is easy to avoid in most cases except within
literal blocks.

bzr revid: odo@openerp.com-20111011171148-rluwokcsx7i38i6e
This commit is contained in:
Olivier Dony 2011-10-11 19:11:48 +02:00
parent 4140e3546a
commit 76c702ca3c
1 changed files with 14 additions and 10 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

24
openerp/osv/orm.py
View File

@ -1175,8 +1175,7 @@ class BaseModel(object):
return {'datas': datas} return {'datas': datas}
def import_data(self, cr, uid, fields, datas, mode='init', current_module='', noupdate=False, context=None, filename=None): def import_data(self, cr, uid, fields, datas, mode='init', current_module='', noupdate=False, context=None, filename=None):
""" """Import given data in given module
Import given data in given module
This method is used when importing data via client menu. This method is used when importing data via client menu.
@ -1191,21 +1190,26 @@ class BaseModel(object):
order_line/product_uom_qty, order_line/product_uom_qty,
order_line/product_uom/id (=xml_id) order_line/product_uom/id (=xml_id)
This method returns a 4-tuple with the following structure: This method returns a 4-tuple with the following structure::
* The first item is a return code, it returns either ``-1`` in case o (return_code, errored_resource, error_message, unused)
:param cr: database cursor * The first item is a return code, it is ``-1`` in case of
:param uid: current user id import error, or the last imported row number in case of success
:param fields: list of fields * The second item contains the record data dict that failed to import
in case of error, otherwise it's 0
* The third item contains an error message string in case of error,
otherwise it's 0
* The last item is currently unused, with no specific semantics
:param fields: list of fields to import
:param data: data to import :param data: data to import
:param mode: 'init' or 'update' for record creation :param mode: 'init' or 'update' for record creation
:param current_module: module name :param current_module: module name
:param noupdate: flag for record creation :param noupdate: flag for record creation
:param context: context arguments, like lang, time zone,
:param filename: optional file to store partial import state for recovery :param filename: optional file to store partial import state for recovery
:returns: 4-tuple of a return code, an errored resource, an error message and ??? :returns: 4-tuple in the form (return_code, errored_resource, error_message, unused)
:rtype: (int, dict|0, str|0, ''|0) :rtype: (int, dict or 0, str or 0, str or 0)
""" """
if not context: if not context:
context = {} context = {}