credativ team mailing list archive
-
credativ team
-
Mailing list archive
-
Message #00479
[Bug 525685] Re: Use __doc__ as a default for _description
> the docstring is quite different from the description.
Indeed, but that's is why we should only use the 1st line of the docstring, which is conventionally a short general-purpose description of the object (http://www.python.org/dev/peps/pep-0257/#multi-line-docstrings).
Lionel.
** Changed in: openobject-server/trunk
Status: Invalid => Opinion
--
You received this bug notification because you are a member of OpenERP
Framework Experts, which is subscribed to the bug report.
https://bugs.launchpad.net/bugs/525685
Title:
Use __doc__ as a default for _description
Status in OpenERP Server:
Opinion
Status in OpenERP Server trunk series:
Opinion
Bug description:
As it turns out, when developers define a dosctring in an object definition, they often use the same as _description. It seems Tryton has even made is a standard to set _description = __doc__, which probably makes sense.
I think it will help is _description defaults to the first line of __doc__.
Lionel
To manage notifications about this bug go to:
https://bugs.launchpad.net/openobject-server/+bug/525685/+subscriptions