Author LambertDW
Recipients LambertDW, dalloliogm
Date 2009-01-09.19:52:58
SpamBayes Score 0.00110133
Marked as misclassified No
Message-id <1231530779.73.0.818206141585.issue4899@psf.upfronthosting.co.za>
In-reply-to
Content
I disagree.  Purpose of __doc__ is to explain functionality all at once.
This command idiom is useful:

$ python -c 'from a_module import thing; help(thing)'

The doctest module is a lightweight nicety that helps verify that which
is suitable.  The sufficiently simple algorithms of my code have doc
strings that are the complete test and explanation.  For others I
provide both docstring and unit tests.  But with many I explain the
arguments and output, possibly the algorithm in a doc string.  Tests and
use case examples reside in the module's unit test.

I'm among the "Choose correct tool for the job.  python comes with full
tool bag." group.
History
Date User Action Args
2009-01-09 19:52:59LambertDWsetrecipients: + LambertDW, dalloliogm
2009-01-09 19:52:59LambertDWsetmessageid: <1231530779.73.0.818206141585.issue4899@psf.upfronthosting.co.za>
2009-01-09 19:52:59LambertDWlinkissue4899 messages
2009-01-09 19:52:58LambertDWcreate