[Zope3-dev] Re: Windows eggs

Marius Gedminas mgedmin at b4net.lt
Sat Jul 14 04:05:09 EDT 2007


On Fri, Jul 13, 2007 at 02:03:04PM -0400, Jim Fulton wrote:
> Of course, I'm a big fan of doctest.  Not all tests are documentation  
> though, even if they are written as doctest.  I'm happy with what  
> we've done. We're making good incremental progress.  I think though  
> that many of our doctests that aspire to be documentation are  
> actually not good documentation.  IMO, we need to separate tests into  
> 2 classes: executable documentation and tests.

+infinity

Absolutely!  Trying to reach two unrelated goals (comprehensive tests +
human-friendly documentation) with one file is just too hard, if not
impossible.

> The executable
> documentation needs to be **much more readable than it is now**.

FWIW, here's a very good example of executable documentation:
https://storm.canonical.com/Tutorial

Marius Gedminas
-- 
We have enough youth, how about a fountain of SMART?
-------------- next part --------------
A non-text attachment was scrubbed...
Name: not available
Type: application/pgp-signature
Size: 189 bytes
Desc: Digital signature
Url : http://mail.zope.org/pipermail/zope3-dev/attachments/20070714/5659774a/attachment-0001.bin


More information about the Zope3-dev mailing list