[FIX] incorrect docstrings or docstring param names not matching actual param names
bzr revid: xmo@openerp.com-20121214130758-a2wp963w4djmb02k
This commit is contained in:
parent
1954c7ae2b
commit
d0a377cb1c
|
@ -228,7 +228,7 @@ class ir_mail_server(osv.osv):
|
||||||
:param int port: SMTP port to connect to
|
:param int port: SMTP port to connect to
|
||||||
:param user: optional username to authenticate with
|
:param user: optional username to authenticate with
|
||||||
:param password: optional password to authenticate with
|
:param password: optional password to authenticate with
|
||||||
:param string encryption: optional: ``'ssl'`` | ``'starttls'``
|
:param string encryption: optional, ``'ssl'`` | ``'starttls'``
|
||||||
:param bool smtp_debug: toggle debugging of SMTP sessions (all i/o
|
:param bool smtp_debug: toggle debugging of SMTP sessions (all i/o
|
||||||
will be output in logs)
|
will be output in logs)
|
||||||
"""
|
"""
|
||||||
|
|
|
@ -129,7 +129,7 @@ def ustr(value, hint_encoding='utf-8', errors='strict'):
|
||||||
:param: value: the value to convert
|
:param: value: the value to convert
|
||||||
:param: hint_encoding: an optional encoding that was detecte
|
:param: hint_encoding: an optional encoding that was detecte
|
||||||
upstream and should be tried first to decode ``value``.
|
upstream and should be tried first to decode ``value``.
|
||||||
:param str error: optional `errors` flag to pass to the unicode
|
:param str errors: optional `errors` flag to pass to the unicode
|
||||||
built-in to indicate how illegal character values should be
|
built-in to indicate how illegal character values should be
|
||||||
treated when converting a string: 'strict', 'ignore' or 'replace'
|
treated when converting a string: 'strict', 'ignore' or 'replace'
|
||||||
(see ``unicode()`` constructor).
|
(see ``unicode()`` constructor).
|
||||||
|
|
|
@ -332,9 +332,9 @@ def generate_table_alias(src_table_alias, joined_tables=[]):
|
||||||
- src_model='res_users', join_tables=[(res.partner, 'parent_id')]
|
- src_model='res_users', join_tables=[(res.partner, 'parent_id')]
|
||||||
alias = ('res_users__parent_id', '"res_partner" as "res_users__parent_id"')
|
alias = ('res_users__parent_id', '"res_partner" as "res_users__parent_id"')
|
||||||
|
|
||||||
:param model src_model: model source of the alias
|
:param model src_table_alias: model source of the alias
|
||||||
:param list join_tables: list of tuples
|
:param list joined_tables: list of tuples
|
||||||
(dst_model, link_field)
|
(dst_model, link_field)
|
||||||
|
|
||||||
:return tuple: (table_alias, alias statement for from clause with quotes added)
|
:return tuple: (table_alias, alias statement for from clause with quotes added)
|
||||||
"""
|
"""
|
||||||
|
@ -351,8 +351,6 @@ def get_alias_from_query(from_query):
|
||||||
""" :param string from_query: is something like :
|
""" :param string from_query: is something like :
|
||||||
- '"res_partner"' OR
|
- '"res_partner"' OR
|
||||||
- '"res_partner" as "res_users__partner_id"''
|
- '"res_partner" as "res_users__partner_id"''
|
||||||
:param tuple result: (unquoted table name, unquoted alias)
|
|
||||||
i.e. (res_partners, res_partner) OR (res_partner, res_users__partner_id)
|
|
||||||
"""
|
"""
|
||||||
from_splitted = from_query.split(' as ')
|
from_splitted = from_query.split(' as ')
|
||||||
if len(from_splitted) > 1:
|
if len(from_splitted) > 1:
|
||||||
|
@ -497,11 +495,19 @@ class ExtendedLeaf(object):
|
||||||
adding joins
|
adding joins
|
||||||
:attr list join_context: list of join contexts. This is a list of
|
:attr list join_context: list of join contexts. This is a list of
|
||||||
tuples like ``(lhs, table, lhs_col, col, link)``
|
tuples like ``(lhs, table, lhs_col, col, link)``
|
||||||
:param obj lhs: source (left hand) model
|
|
||||||
:param obj model: destination (right hand) model
|
where
|
||||||
:param string lhs_col: source model column for join condition
|
|
||||||
:param string col: destination model column for join condition
|
lhs
|
||||||
:param link: link column between source and destination model
|
source (left hand) model
|
||||||
|
model
|
||||||
|
destination (right hand) model
|
||||||
|
lhs_col
|
||||||
|
source model column for join condition
|
||||||
|
col
|
||||||
|
destination model column for join condition
|
||||||
|
link
|
||||||
|
link column between source and destination model
|
||||||
that is not necessarily (but generally) a real column used
|
that is not necessarily (but generally) a real column used
|
||||||
in the condition (i.e. in many2one); this link is used to
|
in the condition (i.e. in many2one); this link is used to
|
||||||
compute aliases
|
compute aliases
|
||||||
|
|
|
@ -3485,7 +3485,7 @@ class BaseModel(object):
|
||||||
|
|
||||||
:param cr: database cursor
|
:param cr: database cursor
|
||||||
:param user: current user id
|
:param user: current user id
|
||||||
:param fields: list of fields
|
:param allfields: list of fields
|
||||||
:param context: context arguments, like lang, time zone
|
:param context: context arguments, like lang, time zone
|
||||||
:return: dictionary of field dictionaries, each one describing a field of the business object
|
:return: dictionary of field dictionaries, each one describing a field of the business object
|
||||||
:raise AccessError: * if user has no create/write rights on the requested object
|
:raise AccessError: * if user has no create/write rights on the requested object
|
||||||
|
@ -4838,7 +4838,7 @@ class BaseModel(object):
|
||||||
Copy given record's data with all its fields values
|
Copy given record's data with all its fields values
|
||||||
|
|
||||||
:param cr: database cursor
|
:param cr: database cursor
|
||||||
:param user: current user id
|
:param uid: current user id
|
||||||
:param id: id of the record to copy
|
:param id: id of the record to copy
|
||||||
:param default: field values to override in the original values of the copied record
|
:param default: field values to override in the original values of the copied record
|
||||||
:type default: dictionary
|
:type default: dictionary
|
||||||
|
|
|
@ -226,9 +226,9 @@ class HttpOptions:
|
||||||
|
|
||||||
Sometimes, like in special DAV folders, the OPTIONS may contain
|
Sometimes, like in special DAV folders, the OPTIONS may contain
|
||||||
extra keywords, perhaps also dependant on the request url.
|
extra keywords, perhaps also dependant on the request url.
|
||||||
@param the options already. MUST be copied before being altered
|
:param opts: MUST be copied before being altered
|
||||||
@return the updated options.
|
:returns: the updated options.
|
||||||
|
|
||||||
"""
|
"""
|
||||||
return opts
|
return opts
|
||||||
|
|
||||||
|
|
|
@ -210,8 +210,8 @@ class graph(object):
|
||||||
|
|
||||||
def exchange(self, e, f):
|
def exchange(self, e, f):
|
||||||
"""Exchange edges to make feasible-tree optimized
|
"""Exchange edges to make feasible-tree optimized
|
||||||
@param edge edge with negative cut-value
|
:param e: edge with negative cut-value
|
||||||
@param edge new edge with minimum slack-value
|
:param f: new edge with minimum slack-value
|
||||||
"""
|
"""
|
||||||
del self.tree_edges[self.tree_edges.index(e)]
|
del self.tree_edges[self.tree_edges.index(e)]
|
||||||
self.tree_edges.append(f)
|
self.tree_edges.append(f)
|
||||||
|
@ -601,8 +601,6 @@ class graph(object):
|
||||||
|
|
||||||
def rank(self):
|
def rank(self):
|
||||||
"""Finds the optimized rank of the nodes using Network-simplex algorithm
|
"""Finds the optimized rank of the nodes using Network-simplex algorithm
|
||||||
|
|
||||||
@param start starting node of the component
|
|
||||||
"""
|
"""
|
||||||
self.levels = {}
|
self.levels = {}
|
||||||
self.critical_edges = []
|
self.critical_edges = []
|
||||||
|
@ -641,8 +639,6 @@ class graph(object):
|
||||||
|
|
||||||
def order_in_rank(self):
|
def order_in_rank(self):
|
||||||
"""Finds optimized order of the nodes within their ranks using median heuristic
|
"""Finds optimized order of the nodes within their ranks using median heuristic
|
||||||
|
|
||||||
@param start: starting node of the component
|
|
||||||
"""
|
"""
|
||||||
|
|
||||||
self.make_chain()
|
self.make_chain()
|
||||||
|
|
Loading…
Reference in New Issue