[Erp5-dev] Proposed more documentation in docstrings

Łukasz Nowak lukasz.nowak at ventis.com.pl
Thu Oct 4 11:08:04 CEST 2007


Hello,

What do you think about putting more documentation in docstrings? There
are many very nice methods, which would need documentation. As its
developer oriented it might be put into docstrings. I think that in
future, when documentation for developer would be generated from
sources such free form extraction would be great comments.

Example attached.

Regards,
Luke

-- 
Łukasz Nowak R&D Ventis http://www.ventis.com.pl/
tel: +48 32 768 16 85 fax: +48 32 392 10 61
``Use the Source, Luke...''
-------------- next part --------------
A non-text attachment was scrubbed...
Name: Predicate.py-setCriterion-docstring-example-invocation.patch
Type: text/x-patch
Size: 603 bytes
Desc: not available
URL: <http://mail.tiolive.com/pipermail/erp5-dev/attachments/20071004/da5f673f/attachment.bin>


More information about the Erp5-dev mailing list