Fix multiline docstring param

This commit is contained in:
Pedro M. Baeza
2014-08-05 18:47:52 +02:00
parent 4e13e0e3b0
commit a33cfa6936
9 changed files with 70 additions and 71 deletions

View File

@@ -209,11 +209,10 @@ class easy_reconcile_advanced(orm.AbstractModel):
def _search_opposites(self, cr, uid, rec, move_line, opposite_move_lines, def _search_opposites(self, cr, uid, rec, move_line, opposite_move_lines,
context=None): context=None):
""" """Search the opposite move lines for a move line
Search the opposite move lines for a move line
:param dict move_line: the move line for which we search opposites :param dict move_line: the move line for which we search opposites
:param list opposite_move_lines: list of dict of move lines values, \ :param list opposite_move_lines: list of dict of move lines values,
the move lines we want to search for the move lines we want to search for
:return: list of matching lines :return: list of matching lines
""" """

View File

@@ -44,11 +44,11 @@ class FileParser(BankStatementImportParser):
**kwargs): **kwargs):
""" """
:param char: parse_name: The name of the parser :param char: parse_name: The name of the parser
:param char: ftype: extension of the file (could be csv, xls or \ :param char: ftype: extension of the file (could be csv, xls or
xlsx) xlsx)
:param dict: extra_fields: extra fields to add to the conversion \ :param dict: extra_fields: extra fields to add to the conversion
dict. In the format {fieldname: fieldtype} dict. In the format {fieldname: fieldtype}
:param list: header : specify header fields if the csv file has no \ :param list: header : specify header fields if the csv file has no
header header
""" """
super(FileParser, self).__init__(parse_name, **kwargs) super(FileParser, self).__init__(parse_name, **kwargs)

View File

@@ -45,9 +45,9 @@ class GenericFileParser(FileParser):
method of statement line in order to record it. It is the responsibility method of statement line in order to record it. It is the responsibility
of every parser to give this dict of vals, so each one can implement his of every parser to give this dict of vals, so each one can implement his
own way of recording the lines. own way of recording the lines.
:param: line: a dict of vals that represent a line of \ :param: line: a dict of vals that represent a line of
result_row_list result_row_list
:return: dict of values to give to the create method of statement \ :return: dict of values to give to the create method of statement
line, it MUST contain at least: line, it MUST contain at least:
{ {
'name':value, 'name':value,

View File

@@ -133,7 +133,7 @@ class BankStatementImportParser(object):
so each one can implement his own way of recording the lines. so each one can implement his own way of recording the lines.
:param: line: a dict of vals that represent a line of result_row_list :param: line: a dict of vals that represent a line of result_row_list
:return: dict of values to give to the create method of statement line,\ :return: dict of values to give to the create method of statement line,
it MUST contain at least: it MUST contain at least:
{ {
'name':value, 'name':value,

View File

@@ -70,7 +70,7 @@ class AccountStatementProfil(orm.Model):
:param: browse_record of the current parser :param: browse_record of the current parser
:param: result_row_list: [{'key':value}] :param: result_row_list: [{'key':value}]
:param: profile: browserecord of account.statement.profile :param: profile: browserecord of account.statement.profile
:param: statement_id: int/long of the current importing \ :param: statement_id: int/long of the current importing
statement ID statement ID
:param: context: global context :param: context: global context
""" """
@@ -100,10 +100,10 @@ class AccountStatementProfil(orm.Model):
At least it fullfill the statement_id. Overide it to add your own At least it fullfill the statement_id. Overide it to add your own
completion if needed. completion if needed.
:param dict of vals from parser for account.bank.statement.line \ :param dict of vals from parser for account.bank.statement.line
(called by parser.get_st_line_vals) (called by parser.get_st_line_vals)
:param int/long statement_id: ID of the concerned account.bank.statement :param int/long statement_id: ID of the concerned account.bank.statement
:return: dict of vals that will be passed to create method of \ :return: dict of vals that will be passed to create method of
statement line. statement line.
""" """
statement_line_obj = self.pool['account.bank.statement.line'] statement_line_obj = self.pool['account.bank.statement.line']

View File

@@ -267,9 +267,9 @@ class AccountBankStatement(orm.Model):
def _prepare_move(self, cr, uid, st_line, st_line_number, context=None): def _prepare_move(self, cr, uid, st_line, st_line_number, context=None):
"""Add the period_id from the statement line date to the move """Add the period_id from the statement line date to the move
preparation. Originaly, it was taken from the statement period_id preparation. Originaly, it was taken from the statement period_id
:param browse_record st_line: account.bank.statement.line record \ :param browse_record st_line: account.bank.statement.line record
to create the move from. to create the move from.
:param char st_line_number: will be used as the name of the \ :param char st_line_number: will be used as the name of the
generated account move generated account move
:return: dict of value to create() the account.move :return: dict of value to create() the account.move
""" """
@@ -290,19 +290,19 @@ class AccountBankStatement(orm.Model):
"""Add the period_id from the statement line date to the move """Add the period_id from the statement line date to the move
preparation. Originaly, it was taken from the statement period_id preparation. Originaly, it was taken from the statement period_id
:param browse_record st_line: account.bank.statement.line record \ :param browse_record st_line: account.bank.statement.line record
to create the move from. to create the move from.
:param int/long move_id: ID of the account.move to link the move \ :param int/long move_id: ID of the account.move to link the move
line line
:param float debit: debit amount of the move line :param float debit: debit amount of the move line
:param float credit: credit amount of the move line :param float credit: credit amount of the move line
:param int/long currency_id: ID of currency of the move line to \ :param int/long currency_id: ID of currency of the move line to
create create
:param float amount_currency: amount of the debit/credit expressed \ :param float amount_currency: amount of the debit/credit expressed
in the currency_id in the currency_id
:param int/long account_id: ID of the account to use in the move \ :param int/long account_id: ID of the account to use in the move
line if different from the statement line account ID line if different from the statement line account ID
:param int/long analytic_id: ID of analytic account to put on the \ :param int/long analytic_id: ID of analytic account to put on the
move line move line
:param int/long partner_id: ID of the partner to put on the move line :param int/long partner_id: ID of the partner to put on the move line
:return: dict of value to create() the account.move.line :return: dict of value to create() the account.move.line
@@ -330,7 +330,7 @@ class AccountBankStatement(orm.Model):
the credit move line for the choosen partner_id the credit move line for the choosen partner_id
=> This will ease the reconciliation process with the bank as the => This will ease the reconciliation process with the bank as the
partner will match the bank statement line partner will match the bank statement line
:param browse_record st_line: account.bank.statement.line record to \ :param browse_record st_line: account.bank.statement.line record to
create the move from. create the move from.
:return: int/long of the res.partner to use as counterpart :return: int/long of the res.partner to use as counterpart
""" """
@@ -348,7 +348,7 @@ class AccountBankStatement(orm.Model):
the profile. the profile.
:param: date: date of the statement used to compute the right period :param: date: date of the statement used to compute the right period
:param: int/long: profile_id: the account.statement.profile ID from \ :param: int/long: profile_id: the account.statement.profile ID from
which to take the bank_statement_prefix for the name which to take the bank_statement_prefix for the name
:return: char: name of the bank statement (st_number) :return: char: name of the bank statement (st_number)
""" """
@@ -483,7 +483,7 @@ class AccountBankStatement(orm.Model):
If amount is negativ, the type supplier If amount is negativ, the type supplier
:param float: amount of the line :param float: amount of the line
:param int/long: partner_id the partner id :param int/long: partner_id the partner id
:return: type as string: the default type to use: 'customer' or \ :return: type as string: the default type to use: 'customer' or
'supplier'. 'supplier'.
""" """
s_line_type = self._compute_type_from_amount(cr, uid, amount) s_line_type = self._compute_type_from_amount(cr, uid, amount)
@@ -517,9 +517,9 @@ class AccountBankStatement(orm.Model):
:param int/long: account_receivable the receivable account :param int/long: account_receivable the receivable account
:param int/long: account_payable the payable account :param int/long: account_payable the payable account
:param int/long: partner_id the partner id :param int/long: partner_id the partner id
:return: dict with [account_id as int/long,type as string]: the \ :return: dict with [account_id as int/long,type as string]: the
default account to be used by statement line as the counterpart of \ default account to be used by statement line as the counterpart of
the journal account depending on the amount and the type as \ the journal account depending on the amount and the type as
'customer' or 'supplier'. 'customer' or 'supplier'.
""" """
account_id = False account_id = False
@@ -656,7 +656,7 @@ class AccountBankStatementLine(orm.Model):
:param int/long partner_id of the line :param int/long partner_id of the line
:param char line_type: a value from: 'general', 'supplier', 'customer' :param char line_type: a value from: 'general', 'supplier', 'customer'
:param float: amount of the line :param float: amount of the line
:return: A dict of value that can be passed directly to the write \ :return: A dict of value that can be passed directly to the write
method of the statement line: method of the statement line:
{'partner_id': value, {'partner_id': value,
'account_id' : value, 'account_id' : value,

View File

@@ -95,7 +95,7 @@ class AccountBankStatement(orm.Model):
"""Create the account move line from the statement line. """Create the account move line from the statement line.
:param int/long move_id: ID of the account.move :param int/long move_id: ID of the account.move
:param int/long st_line_id: ID of the account.bank.statement.line \ :param int/long st_line_id: ID of the account.bank.statement.line
to create the move line from. to create the move line from.
:param int/long company_currency_id: ID of the res.currency of the :param int/long company_currency_id: ID of the res.currency of the
company company

View File

@@ -149,18 +149,18 @@ class AccountBankStatement(Model):
"""Add the period_id from the statement line date to the move """Add the period_id from the statement line date to the move
preparation. Originaly, it was taken from the statement period_id preparation. Originaly, it was taken from the statement period_id
:param browse_record st_line: account.bank.statement.line record to \ :param browse_record st_line: account.bank.statement.line record to
create the move from. create the move from.
:param int/long move_id: ID of the account.move to link the move line :param int/long move_id: ID of the account.move to link the move line
:param float debit: debit amount of the move line :param float debit: debit amount of the move line
:param float credit: credit amount of the move line :param float credit: credit amount of the move line
:param int/long currency_id: ID of currency of the move line to \ :param int/long currency_id: ID of currency of the move line to
create create
:param float amount_currency: amount of the debit/credit expressed \ :param float amount_currency: amount of the debit/credit expressed
in the currency_id in the currency_id
:param int/long account_id: ID of the account to use in the move \ :param int/long account_id: ID of the account to use in the move
line if different from the statement line account ID line if different from the statement line account ID
:param int/long analytic_id: ID of analytic account to put on the \ :param int/long analytic_id: ID of analytic account to put on the
move line move line
:param int/long partner_id: ID of the partner to put on the move line :param int/long partner_id: ID of the partner to put on the move line
:return: dict of value to create() the account.move.line :return: dict of value to create() the account.move.line

View File

@@ -31,9 +31,9 @@ class TransactionIDFileParser(FileParser):
"""Add transaction_id in header keys """Add transaction_id in header keys
:param char: profile: Reference to the profile :param char: profile: Reference to the profile
:param char: ftype: extension of the file (could be csv or xls) :param char: ftype: extension of the file (could be csv or xls)
:param dict: extra_fields: extra fields to add to the conversion \ :param dict: extra_fields: extra fields to add to the conversion
dict. In the format {fieldname: fieldtype} dict. In the format {fieldname: fieldtype}
:param list: header : specify header fields if the csv file has no \ :param list: header : specify header fields if the csv file has no
header header
""" """
extra_fields = {'transaction_id': unicode} extra_fields = {'transaction_id': unicode}
@@ -57,9 +57,9 @@ class TransactionIDFileParser(FileParser):
method of statement line in order to record it. It is the responsibility method of statement line in order to record it. It is the responsibility
of every parser to give this dict of vals, so each one can implement his of every parser to give this dict of vals, so each one can implement his
own way of recording the lines. own way of recording the lines.
:param: line: a dict of vals that represent a line of \ :param: line: a dict of vals that represent a line of
result_row_\list result_row_list
:return: dict of values to give to the create method of statement \ :return: dict of values to give to the create method of statement
line, it MUST contain at least: line, it MUST contain at least:
{ {
'name':value, 'name':value,