launchpad-dev team mailing list archive

[Julian Edwards <julian.edwards@xxxxxxxxxxxxx>]

On Sunday 21 February 2010 20:37:34 Tim Penhey wrote:
> On Sat, 20 Feb 2010 00:47:06 Julian Edwards wrote:
> > Should all model objects should have doc tests?  (ie. testable
> >  documentation)
> >
> > Discuss.
> 
> I think *most* (if not all) model objects should have documentation.
> 
> I think people tend to focus more on the testing bit of the file rather
>  than the documentation bit of the file.


Quite probably, yes.

The sort of thing I'd like to see is a doctest that exercises each 
property/method at least once to explain usage patterns.

The nitty-gritty testing belongs in unit tests.