c2c-oerpscenario team mailing list archive

[xrg <xrg@xxxxxxxxx>]

On Thursday 22 September 2011, you wrote:
> Public bug reported:
> 
> Hello,
> 
> In the docstring methods, the following line is often present :
>   @param uid: the current user’s ID for security checks
> 
++

indeed, have noted this and complained a few weeks ago.

Even more, the (self, cr, uid, ids , context) parameters should not be 
documented at each model.method. They are standard API convention and thus 
need no more explanation.

(yes, there is several methods documenting "self", but not all those cryptic 
parameters after 'ids' ..)

-- 
You received this bug notification because you are a member of C2C
OERPScenario, which is subscribed to OpenERP Project Group.
https://bugs.launchpad.net/bugs/856192

Title:
  [trunk] Docstrings Byte Literal contains non-ascii characters

Status in OpenERP Addons (modules):
  New

Bug description:
  Hello,

  In the docstring methods, the following line is often present :
    @param uid: the current user’s ID for security checks

  The char ’ is not an ascii char and the docstrings are not declared as
  unicode (u"""docstring content""") [1]

  With the command below, 254 lines match.
  grep -hcr "the current user’s ID for security checks" * | awk '{ count += $0} END {print count}'

  I think we should do some sed on all addons to correct that (and server as there is the same issue) like :
  grep -hlr "the current user’s ID for security checks" * | xargs sed -i "s/the current user’s ID for security checks/the current user's ID for security checks/g"

  
  Some others with the same problem:
  grep -hcr "’" * | awk '{ count += $0} END {print count}' (result : 688)
  @param ids: List of open wiki page’s IDs
  @param ids: List of calendar event import’s IDs
  @param data_id: Get Data’s ID or False
  @param ids: List of auction lots enable’s IDs.

  
  Thanks
  Guewen

  [1] http://www.python.org/dev/peps/pep-0257/

To manage notifications about this bug go to:
https://bugs.launchpad.net/openobject-addons/+bug/856192/+subscriptions